Unsubscribe WhatsApp Users from Database / v2

The WhatsApp Unsubscribe API enables you to unsubscribe users from Insider's WhatsApp 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

POST https://contact.useinsider.com/whatsapp/v2/unsubscribe

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 Unsubscribe 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 unsubscribe multiple users from WhatsApp 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.

Shell

curl --location --request POST 'http://contact.useinsider.com/whatsapp/v2/unsubscribe' \
--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

JSON

{
  "statusMessage": "OK"
}

400 Bad Request

JSON

{
  "statusMessage": "Bad request"
}

401 Unauthorized

JSON

{
  "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.