Skip to main content
Send individual SMS messages to contacts. Related APIs:

Types


API Endpoints

Base path: /sms

Send a single SMS to a contact

Flow:
  1. Validates sender ID is active and accessible to the organization (shared or org-owned)
  2. Fetches contact with custom attributes
  3. Checks organization has positive credit balance
  4. Resolves template placeholders with contact data
  5. Sends SMS via provider
  6. Deducts credits (only on successful send)
  7. Returns result
Response:
Error Responses:

Billing

  • Credits are checked before sending (requireCredits - must have positive balance)
  • Credits are deducted only after a successful send
  • Failed sends are not charged
  • Transaction type in credit history: sms_charge (with sms_program_id: null)

SMS Encoding

Message encoding is automatically detected and affects the number of SMS parts: The response includes smsParts and encoding so the caller knows the actual cost breakdown.