Update SMS settings

PATCH/sms/settings

Changes the opt-out message and the other SMS settings. Send only the fields to change. The opt-out message is footer_text, appended to every outbound campaign message while footer_enabled is true. It is not appended to messages sent with POST /sms. Unknown fields and out-of-range values are rejected with 400.

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

Body application/json

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.

Response 200 OK

Settings after the update.

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

400Bad Request
Validation failed / malformed request.
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.