OptOut

DateOptOut

The moment the contact has choosen to opt-out.


Type date
SurveyParticipation

Type string
OptoutSourceId

Origin of the optout.


Type byte
Additional info
ContactId

Unique contact number.


Type integer
FirstName

Contact’s first name.


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

LastName

Contact’s last name.


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

Email

Contact's email address.


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

LangCode

2-letter ISO 639-1 language code


Type string
CustomField1

A field which can be used to store additional contact information.


Type string
CustomField2

A field which can be used to store additional contact information.


Type string
CustomField3

A field which can be used to store additional contact information.


Type string
CustomField4

A field which can be used to store additional contact information.


Type string
CustomField5

A field which can be used to store additional contact information.


Type string
CustomField6

A field which can be used to store additional contact information.


Type string
CustomField7

A field which can be used to store additional contact information.


Type string
CustomField8

A field which can be used to store additional contact information.


Type string
CustomField9

A field which can be used to store additional contact information.


Type string
CustomField10

A field which can be used to store additional contact information.


Type string
CustomField11

A field which can be used to store additional contact information.


Type string
CustomField12

A field which can be used to store additional contact information.


Type string
CustomField13

A field which can be used to store additional contact information.


Type string
CustomField14

A field which can be used to store additional contact information.


Type string
CustomField15

A field which can be used to store additional contact information.


Type string
CustomField16

A field which can be used to store additional contact information.


Type string
CustomField17

A field which can be used to store additional contact information.


Type string
CustomField18

A field which can be used to store additional contact information.


Type string
CustomField19

A field which can be used to store additional contact information.


Type string
CustomField20

A field which can be used to store additional contact information.


Type string
Street

Contact's street name.


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

HouseNumber

Contact's house number.


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

Suite

Contact's apt. number.


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

PostalCode

Postal code.


Type string
City

Contact's city.


Type string
State

ISO 3166-2 two-last letters state code.


Type string
Additional info
Province

Contact's procince.


Type string
Phone

Contact's phone number in the E.164 format (+[country code] [area code] [number])


Type string
Additional info

Not available when retrieving respondents for an anonymous survey

CountryId

ISO 3166-1 two-letter country code.


Type string
Additional info
Gender

Contact's gender.


Type string
Additional info
Matching regular expression pattern: ^[m|M|f|F]$
DateOfBirth

Contact's birthday.


Type date
Additional info
IsBounced

Indicates if the email address for this contact is currently on the bounce list.


Type boolean
IsOptedOut

Indicates if this contact is currently on the opt out list.


Type boolean
Surveys

A list of surveys to which a contact is linked. When retrieving a list of contacts, this property is by default not available. If you would like this additional information, you can use the expand parameter $expand=Surveys.


Type Collection of SurveyReference
Additional info
Groups

A list of groups to which a contact is linked. When retrieving a list of contacts, this property is by default not available. If you would like this additional information, you can use the expand parameter $expand=Groups.


Type Collection of GroupReference
Additional info
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Related Methods

Retrieve the opt-out list of your account taking the passed criteria into account

Occurs when a Panelist doesn't want to receive survey invitations anymore.