Skip to main content

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

FieldTypeRequiredDescription
contentstring✅The content of the SMS. Can include templates if you're only sending to contacts in your org
cellstring✅The cell number of the contact you want to send the SMS to
skipNonContactsboolean✅Whether to skip sending to contacts not in your org
countrystring✅The country code to send to.
deliveryMethod'reverse' | 'standard' | 'transactional'✅The delivery method to use.
sendOptionsSendOptions❌The options for the SMS

Example

{
  "content": "Hello World",
  "cell": "0111111111",
  "skipNonContacts": true,
  "country": "ZA",
  "deliveryMethod": "reverse",
  "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;
}