Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerkstage.dev

createSMSMessage()

Sends an SMS message to a phone number ID belonging to another user:

const phoneNumberId = 'recipient-phone-number-id';
 
const message = 'All glory to the Hypnotoad!';
 
const smsMessage = await clerkClient.smsMessages.createSMSMessage({
  message,
  phoneNumberId
});

Required parameters

NameTypeDescription
phoneNumberIdstringThe ID of the phone number to send the message to.
messagestringThe message to send.

Was this helpful?

Clerk © 2023