| POST | /unsubscribe | Unsubscribe an email from onboarding and similar campaign messages. | No authentication required. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| body | string | Yes | The email address to unsubscribe. | |
| ConfigurationSet | body | string | Yes | Configuration set identifier used when sending the email. |
| Topic | body | string | Yes | Topic identifier used when sending the email. |
| Token | body | string | Yes | Verification token from the unsubscribe link. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| form | string | Yes | ||
| ConfigurationSet | form | string | Yes | |
| Topic | form | string | Yes | |
| Unsubscribed | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /unsubscribe HTTP/1.1
Host: api.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Email":"String","ConfigurationSet":"String","Topic":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Email":"String","ConfigurationSet":"String","Topic":"String","Unsubscribed":false}