Send

The /send endpoint allows you to send SMSs to your contacts.

Send a single SMS

POST /send/sms

Send a single SMS to a contact.

• 🔐 Permissions: ["sendLog.create"]

Request

Body

Field	Type	Required	Description
content	string	✅	The content of the SMS. Can include templates if you're only sending to contacts in your org
cell	string	✅	The cell number of the contact you want to send the SMS to
skipNonContacts	boolean	✅	Whether to skip sending to contacts not in your org
country	string	✅	The country code to send to.
deliveryMethod	'reverse' | 'standard' | 'transactional'	✅	The delivery method to use.
campaign_id	string	❌	The id of the campaign to associate with this send. Allows hooks to trigger on reply.
sendOptions	SendOptions	❌	The options for the SMS

Example

{
  "content": "Hello World",
  "cell": "0111111111",
  "skipNonContacts": true,
  "country": "ZA",
  "deliveryMethod": "reverse",
  "campaign_id": "123",
  "sendOptions": {
    "testMode": true
  }
}

Response

Success

200

{
  ok: true,
  data: {
    // A unique id identifying this particular send
    // Useful for querying the delivery status of this send
    customerId: string,
    totalCost: number,
  }
}

Error

400

{
  ok: false;
  error: string;
}