Name | Description | Type | Additional information |
---|---|---|---|
DateToBeMailed
Date and time on which the invitation will be sent. If not passed, the invitation will be sent once the survey is live or immediately if the survey is already live. Only applies if the SurveyId is passed in the querystring.
Type
date
Additional info
|
|||
DateToBeMailed |
Date and time on which the invitation will be sent. If not passed, the invitation will be sent once the survey is live or immediately if the survey is already live. Only applies if the SurveyId is passed in the querystring. |
date | |
DateToExpire
Date and time on which the invitation should expire and the contact can no longer respond to the survey, if not available the invitation will be active until the survey is closed. Only applies if the SurveyId is passed in the querystring.
Type
date
Additional info
|
|||
DateToExpire |
Date and time on which the invitation should expire and the contact can no longer respond to the survey, if not available the invitation will be active until the survey is closed. Only applies if the SurveyId is passed in the querystring. |
date | |
FirstName
Given name.
Type
string
Additional info
Max length: 50 |
|||
FirstName |
Given name. |
string |
Max length: 50 |
LastName
Family name.
Type
string
Additional info
Max length: 50 |
|||
LastName |
Family name. |
string |
Max length: 50 |
Email
Email address.
Type
string
Additional info
Max length: 100 |
|||
Email address. |
string |
Max length: 100 |
|
LangCode
ISO 639-1 language code. If empty the DefaultLanguage from the querystring will be used, if not available the language from the user who created the api key will be used.
Type
string
Additional info
Max length: 2 |
|||
LangCode |
ISO 639-1 language code. If empty the DefaultLanguage from the querystring will be used, if not available the language from the user who created the api key will be used. |
string |
Max length: 2 |
Phone |
E.164 phone number. |
string |
Max length: 20 |
Gender
M or F.
Type
string
|
|||
Gender |
M or F. |
string | |
DateOfBirth
Date of birth.
Type
date
Additional info
Format as YYYY-MM-DD |
|||
DateOfBirth |
Date of birth. |
date |
Format as YYYY-MM-DD |
Street
Street.
Type
string
Additional info
Max length: 50 |
|||
Street |
Street. |
string |
Max length: 50 |
HouseNumber
House number.
Type
string
Additional info
Max length: 6 |
|||
HouseNumber |
House number. |
string |
Max length: 6 |
Suite
Suite or appartment.
Type
string
Additional info
Max length: 4 |
|||
Suite |
Suite or appartment. |
string |
Max length: 4 |
PostalCode
Postal code.
Type
string
Additional info
Max length: 15 |
|||
PostalCode |
Postal code. |
string |
Max length: 15 |
City
City.
Type
string
Additional info
Max length: 50 |
|||
City |
City. |
string |
Max length: 50 |
State |
ISO 3166-2: US State code. |
string |
Max length: 2 |
Province
Province.
Type
string
Additional info
Max length: 50 |
|||
Province |
Province. |
string |
Max length: 50 |
Country |
ISO 3166-1 Country Code. |
string |
Max length: 2 |
CustomField1
Your own metadata which can be used as a variable in the surveys, display logic and reporting.
Type
string
Additional info
Max length: 256 |
|||
CustomField1 |
Your own metadata which can be used as a variable in the surveys, display logic and reporting. |
string |
Max length: 256 |
CustomField2
Type
string
Additional info
Max length: 256 |
|||
CustomField2 | string |
Max length: 256 |
|
CustomField3
Type
string
Additional info
Max length: 256 |
|||
CustomField3 | string |
Max length: 256 |
|
CustomField4
Type
string
Additional info
Max length: 256 |
|||
CustomField4 | string |
Max length: 256 |
|
CustomField5
Type
string
Additional info
Max length: 256 |
|||
CustomField5 | string |
Max length: 256 |
|
CustomField6
Type
string
Additional info
Max length: 256 |
|||
CustomField6 | string |
Max length: 256 |
|
CustomField7
Type
string
Additional info
Max length: 256 |
|||
CustomField7 | string |
Max length: 256 |
|
CustomField8
Type
string
Additional info
Max length: 256 |
|||
CustomField8 | string |
Max length: 256 |
|
CustomField9
Type
string
Additional info
Max length: 256 |
|||
CustomField9 | string |
Max length: 256 |
|
CustomField10
Type
string
Additional info
Max length: 256 |
|||
CustomField10 | string |
Max length: 256 |
|
CustomField11
Type
string
Additional info
Max length: 256 |
|||
CustomField11 | string |
Max length: 256 |
|
CustomField12
Type
string
Additional info
Max length: 256 |
|||
CustomField12 | string |
Max length: 256 |
|
CustomField13
Type
string
Additional info
Max length: 256 |
|||
CustomField13 | string |
Max length: 256 |
|
CustomField14
Type
string
Additional info
Max length: 256 |
|||
CustomField14 | string |
Max length: 256 |
|
CustomField15
Type
string
Additional info
Max length: 256 |
|||
CustomField15 | string |
Max length: 256 |
|
CustomField16
Type
string
Additional info
Max length: 256 |
|||
CustomField16 | string |
Max length: 256 |
|
CustomField17
Type
string
Additional info
Max length: 256 |
|||
CustomField17 | string |
Max length: 256 |
|
CustomField18
Type
string
Additional info
Max length: 256 |
|||
CustomField18 | string |
Max length: 256 |
|
CustomField19
Type
string
Additional info
Max length: 256 |
|||
CustomField19 | string |
Max length: 256 |
|
CustomField20
Type
string
Additional info
Max length: 256 |
|||
CustomField20 | string |
Max length: 256 |