Unsubscribe API

Our Email Unsubscribe API supports handling unsubscribe requests for email communications. The API can process unsubscribe requests using a unique link.

Fact Sheet

Feature	Support	Remark
Unique Key	Yes	Must be a valid GUID, cannot be empty
Unsubscribe Reason	Yes	Can be provided in the request body

Unsubscribing from Emails

Email Unsubscribe API uses a unique key (GUID) to identify, and process unsubscribe requests. The API also accepts an unsubscribe reason.

The example below shows the simplest unsubscribe request:

POST /email-unsubscribe/v1/unsubscribe/{uniqueKey}
Content-Type: application/json

{
  "unsubscribeReason": "No longer interested"
}

Successful Response

{
    "message": "Success",
    "data": null
}

Error Response

{
    "errorCode": "InvalidRequest",
    "message": "Error message",
    "data": null
}

Status Codes

Status Code	Description
200	OK: Successful unsubscription
400	Bad Request: Invalid request (e.g., empty unique key)
500	Internal Server Error: Server-side error occurred