This Email Unsubscribe API enables you to unsubscribe users from Insider's Email platform.
A newer version of the API, Email Unsubscribe API, is available with support for bulk data ingestion. While the older version is still supported, we recommend using the latest version for improved functionality and future compatibility.
Endpoint and Headers
Visit our Postman collection to test this request.
Headers
| Header | Sample Value | Description |
|---|---|---|
| X-PARTNER-NAME | mybrand | This is your partner name. Navigate to InOne > Inone Settings > Account Preferences to copy your partner name. The partner name should be lowercase. |
| X-REQUEST-TOKEN | 1a2b3c4e5d6f | This key is required to authorize your request. Refer to API Authentication Tokens to generate your Global Unsubscribe token. |
| Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
| Parameter | Description | Data Type | Required |
|---|---|---|---|
| User's email address | String | Yes |
Sample Request
The sample below displays a request to unsubscribe a user from email communications. The request body must include the subscriber’s email address, which is used to identify and remove them from active email subscriptions.
curl --location --request POST 'https://contact.useinsider.com/email/v1/unsubscribe' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "sample@useinsider.com"
}'Sample Responses
200 OK
{
"statusMessage": "OK"
}400 Bad Request
{
"statusMessage": "Bad request"
}401 Unauthorized
{
"statusMessage": "Unauthorized"
}Limitations
- All functions must be executed with a simple HTTPS POST request.
- Only global unsubscribers can be sent via this API. No data can be retrieved.
- The API Key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.
- The value of the X-PARTNER-NAME header should be lowercase.