Sign in

v1

latestOpenAPI 3.0.12026-07-144713.2 KB
Status

Unsubscribe a contact

Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.

post/communication-preferences/v3/unsubscribe

Request body

emailAddressstring required

Contact's email address.

legalBasis'LEGITIMATE_INTEREST_PQL' | 'LEGITIMATE_INTEREST_CLIENT' | 'PERFORMANCE_OF_CONTRACT' | 'CONSENT_WITH_NOTICE' | 'NON_GDPR' | 'PROCESS_AND_STORE' | 'LEGITIMATE_INTEREST_OTHER'

Legal basis for updating the contact's status (required for GDPR enabled portals).

legalBasisExplanationstring

A more detailed explanation to go with the legal basis (required for GDPR enabled portals).

subscriptionIdstring required

ID of the subscription being updated for the contact.

Response

successful operation

brandIdinteger

The ID of the brand that the subscription is associated with, if there is one.

descriptionstring required

A description of the subscription.

idstring required

The ID for the subscription.

legalBasis'LEGITIMATE_INTEREST_PQL' | 'LEGITIMATE_INTEREST_CLIENT' | 'PERFORMANCE_OF_CONTRACT' | 'CONSENT_WITH_NOTICE' | 'NON_GDPR' | 'PROCESS_AND_STORE' | 'LEGITIMATE_INTEREST_OTHER'

The legal reason for the current status of the subscription.

legalBasisExplanationstring

A more detailed explanation to go with the legal basis.

namestring required

The name of the subscription.

preferenceGroupNamestring

The name of the preferences group that the subscription is associated with.

sourceOfStatus'PORTAL_WIDE_STATUS' | 'BRAND_WIDE_STATUS' | 'SUBSCRIPTION_STATUS' required

Where the status is determined from e.g. PORTAL_WIDE_STATUS if the contact opted out from the portal.

status'SUBSCRIBED' | 'NOT_SUBSCRIBED' required

Whether the contact is subscribed.