NameDescriptionTypeAdditional information
CompanyID

Unique identifier for your Digital Communication account

string

None.

CampaignID

If the person opted-out using the unsubscribe link within the email this is an internal unique identifier for the email

string

None.

CampaignName

The name given to the email when creating the email

string

None.

CreatedDate

The date and time of the unsubscribe (email opt-out)

date

None.

EmailAddress

The email address that is permanently blocked

string

None.

CustomField1

This is 1 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField2

This is 2 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField3

This is 3 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField4

This is 4 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField5

This is 5 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField6

This is 6 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField7

This is 7 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField8

This is 8 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField9

This is 9 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

CustomField10

This is 10 of 10 fields that you can use to add additional data that will not be included in the email sent. E.g., a Unique customer/member number, an additional field that you want to use to integrate with other systems

string

None.

Reason

If provided, the reason the person gave for unsubscribing

string

None.

IsSuccessful

Indicator of whether the request was successful

boolean

None.

ErrorMessage

This will contain details of the error if it was not successful

string

None.