| Name | Description | Type | Additional information |
|---|---|---|---|
|
DateOptOut
The moment the contact has choosen to opt-out.
Type
date
|
|||
| DateOptOut |
The moment the contact has choosen to opt-out. |
date | |
|
SurveyParticipation
Type
string
|
|||
| SurveyParticipation | string | ||
| OptoutSourceId |
Origin of the optout. |
byte | |
|
ContactId
Unique contact number.
Type
integer
|
|||
| ContactId |
Unique contact number. |
integer | |
|
FirstName
Contact’s first name.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
| FirstName |
Contact’s first name. |
string |
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 |
|||
| LastName |
Contact’s last name. |
string |
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 |
|||
|
Contact's email address. |
string |
Not available when retrieving respondents for an anonymous survey |
|
| LangCode |
2-letter ISO 639-1 language code |
string | |
|
CustomField1
A field which can be used to store additional contact information.
Type
string
|
|||
| CustomField1 |
A field which can be used to store additional contact information. |
string | |
|
CustomField2
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. |
string | |
|
CustomField3
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. |
string | |
|
CustomField4
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. |
string | |
|
CustomField5
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. |
string | |
|
CustomField6
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. |
string | |
|
CustomField7
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. |
string | |
|
CustomField8
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. |
string | |
|
CustomField9
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. |
string | |
|
CustomField10
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. |
string | |
|
CustomField11
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. |
string | |
|
CustomField12
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. |
string | |
|
CustomField13
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. |
string | |
|
CustomField14
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. |
string | |
|
CustomField15
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. |
string | |
|
CustomField16
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. |
string | |
|
CustomField17
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. |
string | |
|
CustomField18
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. |
string | |
|
CustomField19
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. |
string | |
|
CustomField20
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. |
string | |
|
Street
Contact's street name.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
| Street |
Contact's street name. |
string |
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 |
|||
| HouseNumber |
Contact's house number. |
string |
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 |
|||
| Suite |
Contact's apt. number. |
string |
Not available when retrieving respondents for an anonymous survey |
|
PostalCode
Postal code.
Type
string
|
|||
| PostalCode |
Postal code. |
string | |
|
City
Contact's city.
Type
string
|
|||
| City |
Contact's city. |
string | |
| State |
ISO 3166-2 two-last letters state code. |
string | |
|
Province
Contact's procince.
Type
string
|
|||
| Province |
Contact's procince. |
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 |
|||
| Phone |
Contact's phone number in the E.164 format (+[country code] [area code] [number]) |
string |
Not available when retrieving respondents for an anonymous survey |
| CountryId |
ISO 3166-1 two-letter country code. |
string | |
|
Gender
Contact's gender.
Type
string
Additional info
Matching regular expression pattern: ^[m|M|f|F]$
|
|||
| Gender |
Contact's gender. |
string |
Matching regular expression pattern: ^[m|M|f|F]$ |
|
DateOfBirth
Contact's birthday.
Type
date
Additional info
* ISO 8601 format * Not available when retrieving respondents for an anonymous survey |
|||
| DateOfBirth |
Contact's birthday. |
date |
* ISO 8601 format * Not available when retrieving respondents for an anonymous survey |
|
IsBounced
Indicates if the email address for this contact is currently on the bounce list.
Type
boolean
|
|||
| IsBounced |
Indicates if the email address for this contact is currently on the bounce list. |
boolean | |
|
IsOptedOut
Indicates if this contact is currently on the opt out list.
Type
boolean
|
|||
| IsOptedOut |
Indicates if this contact is currently on the opt out list. |
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
Type
Collection of SurveyReference
Additional info
|
|||
| 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 |
Collection of SurveyReference | |
|
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
Type
Collection of GroupReference
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 |
Collection of GroupReference | |
| 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. |
Hateoas | |