The Email Resubscribe API allows you to set an unreachable email status as reachable on the Insider's Email platform.
API usage changes depending on the identifier format you're using. Please refer to the relevant section based on your identifier configuration.
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 Resubscribe token. |
| Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
For Email Global Subscribe
| Parameter | Description | Data Type | Required |
|---|---|---|---|
| emails | User's email address(es) | String Array | es (normal and email-based) |
| uuids | Users unique user identifier | String Array | Yes (only if you are not using email as an identifier and using profile-based) |
For Email Group Subscribe
| Parameter | Description | Data Type | Required |
|---|---|---|---|
| emails | User's email address | String Array | Yes |
| uuids | Users unique user identifier | String Array | Yes (only if you are using profile based flow) |
| group_id | The Unsubscribe Group’s ID. | Number | Yes |
Sample Requests
When Email is the Identifier or Email-Based Flow is Enabled
Resubscribe Users
The sample below displays a request to globally subscribe multiple users by email.
Every request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
curl --location --request POST 'http://contact.useinsider.com/email/v2/subscribe' \
--header 'Content-Type: application/json' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \
--data-raw '{
"emails": [
"sample1@useinsider.com",
"sample2@useinsider.com"
]
}'Resubscribe Users from Unsubscribe Groups
The sample below displays a request to resubscribe users to a specific unsubscribe group by email.
Every request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
curl --location --request POST 'http://contact.useinsider.com/email/v2/subscribe' \
--header 'Content-Type: application/json' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \
--data-raw '{
"emails": [
"sample1@useinsider.com",
"sample2@useinsider.com"
],
"group_id": 12345
}'When UUID is the Identifier and Profile-Based Flow is Enabled
Resubscribe Users
The sample below displays a request to resubscribe users when the UUID is the identifier and profile-based flow is enabled.
Every request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
- If the user in the request exists, their status will be updated.
- If the user does not exist, a new user will be created.
curl --location 'https://contact.useinsider.com/email/v2/subscribe' \
--header 'Content-Type: application/json' \
--header 'x-request-token: mybrand' \
--header 'x-partner-name: a1b2c3d4e5f6' \
--data-raw '{
"uuids": [
"test-uuid-1",
"test-uuid-2",
"test-uuid-3",
"test-uuid-7"
],
"emails": [
"samlpe1@useinsider.com",
"sample2@useinsider.com",
"sample3@useinsider.com",
"sample4@useinsider.com"
]
}'Resubscribe Users from Unsubscribe Groups
The sample below displays a request to resubscribe users from a specific unsubscribe group by email.
Every request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata.
curl --location 'https://contact.useinsider.com/email/v2/subscribe' \
--header 'Content-Type: application/json' \
--header 'x-request-token: mybrand' \
--header 'x-partner-name: a1b2c3d4e5f6' \
--data-raw '{
"uuids": [
"test-uuid-1",
"test-uuid-2",
"test-uuid-3",
"test-uuid-7"
],
"emails": [
"sample1@useinsider.com",
"sample2@useinsider.com",
"sample3@useinsider.com",
"sample4@useinsider.com"
],
"group_id": 12345
}'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.
- A maximum of 500 emails or UUIDs can be consumed in one request.
- 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 X-PARTNER-NAME header should be lowercase.
The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.