Resubscribe Email Users / v2
- 27 Nov 2023
- 1 Minute to read
Resubscribe Email Users / v2
- Updated on 27 Nov 2023
- 1 Minute to read
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
This API allows you to set an unreachable email status as reachable on Insider's email platform.
The resubscribe API v2 differs from the resubscribe API v1 because it makes a user subscribe to a group and its limit to send resubscribe users is 500 in a single request.
Endpoint and Headers
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 Resubscribe token. |
Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
Parameter | Description | Data Type | Required |
---|---|---|---|
email(s) | User's email address(es) | Array of String | Yes |
uploader_email | Your uploader email address | String | Yes |
group_id | ID of the unsubscribe group. Without the unsubscribe group_id, the request is considered as a bulk resubscribe. | Number | Optional |
Sample Example
Sample Request
Every request made to the request endpoint requires a request body formatted in JSON and containing your email's content and metadata. This includes the subscriber's email address.
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": [
"example1@useinsider.com",
"example2@useinsider.com"
],
"group_id": 12345,
"uploader_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 emails can be sent via this API. No data can be retrieved.
- A maximum of 500 emails can be consumed in one request.
- The API Key should be provided as the authorization key on 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.
Was this article helpful?