Skip to main content
POST
/
contact
/
send
/
sms
Send SMS to Contact
curl --request POST \
  --url https://api.getoutbox.ai/contact/send/sms/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>"
}
'
{
  "message_id": "<string>",
  "thread_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
phone_number_id
string<uuid>
required

Phone number ID to send from.

​
phone_number_owner
enum<string>
required

Whether the number lives under the company or its agency.

  • company - company
  • agency - agency
Available options:
company,
agency
​
contact_id
string<uuid>
required

Recipient contact UUID.

​
message
string
required

Message body. Supports {{contact.first_name}}, {{company.name}}, etc.

Minimum string length: 1

Response

​
message_id
string
required

Twilio message SID.

​
thread_message_id
string<uuid>
required

Internal ThreadMessage row ID.

​
status
string
required