Unsubscribe a contact

POST {{baseUrl}}/communication-preferences/v3/unsubscribe

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.

Request Body

{"emailAddress"=>"<string>", "subscriptionId"=>"<string>", "legalBasis"=>"CONSENT_WITH_NOTICE", "legalBasisExplanation"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceOfStatus&quot;:&quot;PORTAL_WIDE_STATUS&quot;,&quot;status&quot;:&quot;NOT_SUBSCRIBED&quot;,&quot;brandId&quot;:&quot;\u003clong\u003e&quot;,&quot;preferenceGroupName&quot;:&quot;\u003cstring\u003e&quot;,&quot;legalBasis&quot;:&quot;LEGITIMATE_INTEREST_PQL&quot;,&quot;legalBasisExplanation&quot;:&quot;\u003cstring\u003e&quot;}