latestOpenAPI 3.0.12026-08-10254561.9 KB

2ea4b8555197

Distribution

Retrieve an existing unsubscribe contact.

get/distribution/unsubscribe/{id}

Path parameters

idinteger required

The ID of the requested unsubscribe contact.

Headers

Accept-Versionstring

The requested API version

Response

OK

Idinteger

The ID of the unsubscribe contact.

Activeboolean

Shows whether the unsubscribed contact is active.

Emailstring

The email address. If provided, must be a valid email address.

Phonestring

The phone number. If provided, must be a valid phone number.

SurveyIdinteger

The ID of the survey from which an email address or a phone number was added using an unsubscribe link.

SurveyNamestring

The name of the survey from which an email address or a phone number was added using an unsubscribe link.

RespondentIdinteger

The ID of the respondent for whom an email address or a phone number was added using an unsubscribe link.

Custom1string

Custom field to store additional information.

Custom2string

Custom field to store additional information.

Custom3string

Custom field to store additional information.

Custom4string

Custom field to store additional information.

Custom5string

Custom field to store additional information.

Custom6string

Custom field to store additional information.

Custom7string

Custom field to store additional information.

Custom8string

Custom field to store additional information.

Custom9string

Custom field to store additional information.

Custom10string

Custom field to store additional information.

CreatedByIdinteger

The ID of the user who added the email or phone number to the list.

CreatedBystring

The username of the user who added the email or phone number to the list.

CreatedOnstring date-time

The date and time the email address or phone number was added to the list.

ModifiedByIdinteger

The ID of the user who last modified the email address or phone number.

ModifiedBystring

The username of the user who last modified the email address or phone number.

ModifiedOnstring date-time

The date and time the email address or phone number was last modified.