SMS Messages

This object represents an SMS message that has been sent to a phone number. You can only send an SMS message to phone numbers that have been verified by a user. Only recommended for transactional SMS messages.

Available requests

  • POST/v1/sms_messages

Example SMS message schema

{
"object": "sms_message",
"id": "sms_1q8uR4AxV2G8l6dgbtuwh4Gorws",
"from_phone_number": "9738321914",
"to_phone_number": "+12019613198",
"phone_number_id": "idn_1oDEYpGZ9m7XbIyqaML55jEaETE",
"message": "Welcome to Clerk!",
"status": "queued"
}

post
Create an SMS message

https://api.clerk.dev/v1/sms_messages
Create and send an SMS message to the supplied phone number ID.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Form Data Parameters
phone_number_id
required
string
The ID of a verified phone number.
message
required
string
The message you would like to send.
Response
200: OK
// see example schema
{
"object": "sms_message",
"id": "sms_1q8uR4AxV2G8l6dgbtuwh4Gorws"
...
}