v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB

SMS

Get SMS settings

Returns the company's SMS add-on status, including credit balance, phone numbers, and whether SMS sequence steps will actually send.

get/sms/settings

Response

SMS settings returned successfully

successboolean

messagestring

Example response

{
  "success": true,
  "sms": {
    "enabled": true,
    "planEligible": true,
    "creditsBalance": 4200,
    "brandPrefix": "Acme",
    "numbers": [
      {
        "e164": "+18885550123",
        "status": "active"
      }
    ],
    "readyToSend": true
  },
  "message": "SMS is enabled and ready to send."
}