Unsubscribe WhatsApp Users from Database
- 07 Aug 2023
- 1 Minute to read
Unsubscribe WhatsApp Users from Database
- Updated on 07 Aug 2023
- 1 Minute to read
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
This API enables you to unsubscribe users from Insider's WhatsApp platform.
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 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 |
Sample Example
Sample Request
Every request made to the request endpoint requires a request body formatted in JSON and containing your phone number’s content and metadata. This includes the subscriber’s phone number.
curl --location --request POST 'https://contact.useinsider.com/whatsapp/v1/unsubscribe' \
--header 'Content-Type: application/json' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: a1b2c3d4e5f6' \
--data-raw '{
"phone_number": "+905012345678"
}'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 global unsubscribers can be sent via this API. No data can be retrieved.
- 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?