The SMS Unsubscribe API enables you to unsubscribe users from Insider One's SMS product.
A newer version of the Unsubscribe API is available, supporting 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 Settings 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 |
|---|---|---|---|
phone_number | User's phone number in E.164 format (e.g. +6598765432) | String | Yes |
The phone number validation system detects issues such as redundant country codes or incorrect formats and accepts only valid numbers. All phone numbers are automatically standardized to the correct format, whether uploaded with or without a country code.
Sample Request
The sample below displays a request to unsubscribe a user from SMS communications.
Every request to the request endpoint requires a JSON-formatted request body containing your phone number’s content and metadata, including the subscriber’s phone number.
curl --location --request POST 'https://contact.useinsider.com/sms/v1/unsubscribe' \
--header 'Content-Type: application/json' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \
--data-raw '{
"phone_number": "+6598765432"
}'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 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.