Skip to main content
POST
Send OTP
The template you use must be approved and in the Authentication category. The response includes a reference. Save it, because you need it to verify, resend or cancel the code. Each code works for 10 minutes. To change this, set expiry_minutes to a value from 1 to 60. You can send up to 5 codes per hour and 20 codes per day to the same phone number.

Authorizations

Authorization
string
header
required

Your API key. Create one under Setup → Developer API Keys and select the permissions this endpoint needs.

Scopes

otp:send

Body

application/json
phone
string
required

The customer's phone number with country code, for example 919876543210.

Maximum string length: 20
channel_id
integer
required

The ID of the WhatsApp number you send from. Find it under endpoints in List Channels.

template_id
integer
required

An approved template from the Authentication category.

purpose
string | null

Optional. A label for your own use, such as login.

Maximum string length: 50
expiry_minutes
integer | null

Optional. How long the code works, from 1 to 60 minutes. Default is 10.

Required range: 1 <= x <= 60

Response

202 Accepted

data
object