SMS

Get SMS settings

Changed on

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

get/sms/settings

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sms/settings
  • Auth
    HTTP bearer

Response

SMS settings returned successfully

successboolean
messagestring

Example response

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

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status