Unsubscribe from messages
The Engage API has endpoints to allow unsubscribing of contacts from emails and SMS messages.
Unsubscribe from a specific message
Using these two endpoints, a contact can be unsubscribed from a specific email or SMS. This is effectively the same as them unsubscribing via the unsubscribe link in an email, or through the unsubscribe link in an SMS.
POST /api/v2/contacts/{contactId}/unsubscribeEmail?messageId={messageId}
POST /api/v2/contacts/{contactId}/unsubscribeSms?messageId={messageId}
Note
If messageId is not sent in the request, the messageId of the last message received by the contact will be used.
Field | Type | Example value |
|---|---|---|
contactId (mandatory) | GUID | a67b201f-d86d-4ee2-bdc7-abce0080a803 |
messageId | GUID | f0370cc7-5428-4cc3-85c9-ad0800f0bc28 |