NewContact

NameDescriptionTypeAdditional 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.

date

ISO 8601 format

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

ISO 8601 format

FirstName

Given name.

string

Max length: 50

LastName

Family name.

string

Max length: 50

Email

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.

string

Max length: 2

Phone

E.164 phone number.

string

Max length: 20

Gender

M or F.

string

DateOfBirth

Date of birth.

date

Format as YYYY-MM-DD

Street

Street.

string

Max length: 50

HouseNumber

House number.

string

Max length: 6

Suite

Suite or appartment.

string

Max length: 4

PostalCode

Postal code.

string

Max length: 15

City

City.

string

Max length: 50

State

ISO 3166-2: US State code.

string

Max length: 2

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.

string

Max length: 256

CustomField2 string

Max length: 256

CustomField3 string

Max length: 256

CustomField4 string

Max length: 256

CustomField5 string

Max length: 256

CustomField6 string

Max length: 256

CustomField7 string

Max length: 256

CustomField8 string

Max length: 256

CustomField9 string

Max length: 256

CustomField10 string

Max length: 256

CustomField11 string

Max length: 256

CustomField12 string

Max length: 256

CustomField13 string

Max length: 256

CustomField14 string

Max length: 256

CustomField15 string

Max length: 256

CustomField16 string

Max length: 256

CustomField17 string

Max length: 256

CustomField18 string

Max length: 256

CustomField19 string

Max length: 256

CustomField20 string

Max length: 256

Related Methods

Verb Url Description
POST 3/contacts?SurveyId={SurveyId}

Create a new contact in a survey

POST 3/contacts?contactListId={contactListId}

Create a new contact in a contact list

POST 3/contactgroups/{GroupId}/contacts?SurveyId={SurveyId}&ReuseExisting={ReuseExisting}&EmailRequired={EmailRequired}&DefaultLanguage={DefaultLanguage}

Add a contact to the contactgroup