Home
Search…
3.0.0
Welcome to Clerk API Reference
Clerk's Guides and Docs
Questions? We're here for you.
API Reference
Backend API
Introduction
Allowlist Identifiers
Clients
Invitations
Email Addresses
Emails
Organizations
Organization Invitations
Organization Memberships
Redirect URLs
Sessions
Sign In Tokens
SMS Messages
Users
Beta Features
Frontend API
Powered By
GitBook
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
https://api.clerk.dev
/v1/sms_messages
Create an SMS message
Previous
Sign In Tokens
Next
Users
Last modified
4mo ago
Copy link
Outline
Available requests
Example SMS message schema
post
Create an SMS message