Docs
Open dashboard

Get SMS settings

GET/sms/settings

Returns the workspace's SMS settings, including the opt-out message. Unset values come back as their defaults.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Response 200 OK

SMS settings.

  • footer_enabledbooleanoptional
    Append the opt-out message to every outbound campaign message.
  • footer_textstring0–120 charsoptional
    The opt-out message.
  • max_segmentsinteger1–5optional
    Cap on campaign message length in segments.
  • retry_enabledbooleanoptional
    Re-send failed campaign messages automatically.
  • retry_max_attemptsinteger1–3optional
    Total attempts per recipient including the first.
  • retry_delay_minutesinteger5–120optional
  • custom_variablesstring[]optional
    Workspace-defined template variables. Letters, digits and underscores, max 40 characters each.

Errors

  • 401Unauthorized
    Missing, malformed, or invalid API key.
  • 403Forbidden
    Workspace unavailable, suspended, or paywalled.
  • 429Too Many Requests
    Workspace request limit exceeded; shared across all its API keys.