Skip to main content
PATCH
Update Fallback SMS Config
Everything on the Settings → Fallbacks page is available here, so backup SMS can be set up entirely over the API without opening the dashboard.A backup text goes out when iMessage cannot deliver, for two separate reasons: the send failed technically, or the recipient has no iMessage. Both use the same destination.
Send only the fields you want to change. Omitting a credential leaves the stored one untouched, so you can change the number without re-sending keys. Setting telnyxUseOwnAccount to false deletes them.

Authentication

Pass your workspace API key as a Bearer token, or use a Clerk session token.

Request body

string
none, ghl, twilio or telnyx. none turns backup texts off entirely.
string
E.164. The number backup texts are sent from, and where replies come back to.
boolean
default:"false"
Send on your own Telnyx account instead of Tuco’s, keeping the number, the 10DLC registration and the billing under your brand. Setting this to false deletes any stored credentials.
string
Write only. Telnyx portal → Account → API Keys. Never returned by GET.
string
Write only. Telnyx portal → Account → Public Key. Without it, replies from your leads are rejected as unverified.
boolean
Also fall back on a technical send failure, not only when the recipient has no iMessage. Setting this before a destination is configured returns FALLBACK_NOT_CONFIGURED.
string
reschedule or fallback — what to do when the line hits its daily cap.

Examples

Success (200 OK)

Read the full config back with GET /api/workspace/fallback-config.

Using your own Telnyx account

Both keys are required together. The API key is checked with Telnyx before anything is stored, including that telnyxFromNumber is a number on that account — so a wrong key fails here rather than the first time a text needs to go out. Replies only reach you once Telnyx knows where to send them. In Telnyx, go to Messaging → Messaging Profiles → your profile → Inbound Settings, set the Webhook URL to:
and set API version to 2. The URL is the same for everyone; replies are matched to you by telnyxFromNumber.

Send a test

Sends a real text through the saved settings, so it proves the credentials and the number together. Save first — it reads what is stored, not what you pass.
string
required
Which destination to test: ghl, twilio, telnyx, custom_webhook or campaign_ghl_path.
string
E.164 number to send the test text to. Required for ghl, twilio and telnyx.
details.account tells you which account it actually went out on, so you can confirm you are on your own rather than Tuco’s.

Error codes

Returned on PATCH as { "error": "...", "code": "..." }.