Skip to main content
POST
/
v1
/
otps
/
whatsapp
/
send
C#
// POST /v1/otps/whatsapp/send
const stytch = require('stytch');

const client = new stytch.Client({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  phone_number: "${examplePhoneNumber}",
};

client.OTPs.WhatsApp.Send(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
{
  "request_id": "<string>",
  "user_id": "<string>",
  "phone_id": "<string>",
  "status_code": 123
}
This endpoint sends a one-time passcode (OTP) to a user’s WhatsApp using their phone number. If you’d like to create a user and send them a passcode with one request, use the login or create user endpoint. Sending an OTP code will invalidate any previously sent OTP code for the same user.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request type

​
phone_number
string
required

The phone number to use for one-time passcodes. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see Testing for more detail.

​
expiration_minutes
integer<int32>

Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.

​
attributes
object

Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application.

​
locale
enum<string>

Used to determine which language to use when sending the user this delivery method. Parameter is an IETF BCP 47 language tag, e.g. "en".

Currently supported languages are English ("en"), Spanish ("es"), French ("fr") and Brazilian Portuguese ("pt-br"); if no value is provided, the copy defaults to English.

Request support for additional languages here!

Available options:
en,
es,
pt-br,
fr
​
user_id
string

The unique ID of a specific User. You may use an external_id here if one is set for the user.

​
session_token
string

The session_token associated with a User's existing Session.

​
session_jwt
string

The session_jwt associated with a User's existing Session.

Response

Successful response

​
request_id
string
required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

​
user_id
string
required

The unique ID of the affected User.

​
phone_id
string
required

The unique ID for the phone number.

​
status_code
integer<int32>
required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.