The SMS Resubscribe API enables you to update an unreachable phone number status to reachable on Insider One's SMS platform.
If a user exists with the provided phone number, the user's subscription status will be updated. If no user exists and the phone number is used as an identifier, a new user will be created.
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
| Parameter | Description | Data Type | Required |
|---|---|---|---|
| phone_numbers | Users' phone numbers in E.164 format (e.g. +6598765432) | String Array | Yes |
Sample Request
The sample below displays a request to subscribe multiple users to SMS communications.
Every request made to the request endpoint requires a request body formatted in JSON containing your phone number’s content and metadata, including the subscriber’s phone number.
Your title goes here
The phone_numbers field is required for resubscribe requests.
curl --location --request POST 'http://contact.useinsider.com/sms/v2/subscribe' \
--header 'Content-Type: application/json' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \
--data-raw '{
"phone_numbers": [
"+900000000000",
"+900000000000",
"+900000000000",
"+900000000000",
"+900000000000",
"+900000000000"
]
}'Sample Responses
The following are some sample responses you might receive for your request.
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 phone numbers can be sent via this API. No data can be retrieved.
- A maximum of 500 phone numbers 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 the 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.