Once your OTP templates are created, you might need to revise them over time. This section describes how to update WhatsApp OTP templates already registered in your WhatsApp Business Account.
Endpoint and Headers
This API key is sensitive and should never be used on the frontend or mobile SDK; it should only be implemented on the backend.
Visit our Postman collection to test this request.
Headers
| Header | Sample Value | Description |
|---|---|---|
| X-INS-AUTH-KEY | 1a2b3c4d5e6f | This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. |
| Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
| Parameter | Description | Data Type | Required | Rules |
|---|---|---|---|---|
| channel | The channel that you will send the OTP code to. | String | Yes | oneof:whatsapp |
| locale | Determines the language/locale in which the OTP code message will be sent. | String | Yes | oneof:pt af sq ar az bn bg ca zh_CN zh_HK zh_TW hr cs da nl en en_GB en_US et fil fi fr ka de el gu ha he hi hu id ga it ja kn kk rw_RW ko ky_KG lo lv lt mk ms ml mr nb fa pl pt_BR pt_PT pa ro ru sr sk sl es es_AR es_ES es_MX sw sv ta te th tr uk ur uz vi zu |
| text | Defines the template text that will be used for generating OTP code messages. | String | Yes | max:100 |
Sample Request
Every request made to the request endpoint requires a request body formatted in JSON and containing your parameters.
Your title goes here
Make sure to replace the sample values in the request header(s) and body where required before sending your request.
Below is a sample request to update an existing WhatsApp verification template by specifying its locale and template name.
curl --location 'verify.useinsider.com/v1/template/update' \
--header 'Content-Type: application/json' \
--header 'x-ins-auth-key: 1a2b3c4d5e6f' \
--data '{
"channel": "whatsapp",
"locale": "en",
"templateName": "sample_template_name"
}'Sample Responses
202 Accepted
This response indicates that your request was successfully completed.
{
"status": "success"
}400 Bad Request: Invalid request payload
{
"errors": [
{
"message": "invalid request payload"
}
]
}400 Bad Request: Missing required field
{
"errors": [
{
"message": "this field is required",
"field": "text"
}
]
}401 Unauthorized
{
"errors": [
{
"message": "unauthorized"
}
]
}409 Conflict
{
"errors": [
{
"message": "no changes detected"
}
]
}429 Too Many Requests
{
"errors": [
{
"message": "rate limit exceeded"
}
]
}500 Internal Server Error
{
"errors": [
{
"message": "server error"
}
]
}Limitations
- All functions must be executed with a simple HTTPS POST 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 be returned in the response.
- The service is subject to a rate limit of 100 requests per second to ensure optimal system performance, and clients exceeding this limit will receive an HTTP 429 Too Many Requests response.
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.