Clerk docs

SMS Messages

SMS messages can be sent to verified phone numbers that belong to users. This functionality is only recommended for transactional SMS messages.

Create an SMS message

Create and send an SMS message to the supplied phone number ID

SecuritybearerAuth
Request
Request Body schema: application/json

Required parameters

message
string or null

The message you would like to send

phone_number_id
string

The ID of a verified phone number the SMS message should be sent to

Responses
200

Success

400

Request was not successful

401

Authentication invalid

403

Authorization invalid

404

Resource not found

post/sms_messages
Request samples
application/json
{
  • "message": "string",
  • "phone_number_id": "string"
}
Response samples
application/json
{
  • "object": "sms_message",
  • "id": "string",
  • "slug": "string",
  • "from_phone_number": "string",
  • "to_phone_number": "string",
  • "phone_number_id": "string",
  • "user_id": "string",
  • "message": "string",
  • "status": "string",
  • "data": { },
  • "delivered_by_clerk": true
}
➔ Next to Users