connections

Update a connection (re-syncs the carrier)

patch/connections/{id}

Request

Base URL: https://api.saperly.com
URL: https://api.saperly.com/connections/{id}
Auth: none required

Path parameters

idstring required

The connection's id.

Request body

namestring nullable

A human-readable name for the connection (1–120 characters).

mode'hosted' | 'manual' nullable

How the line is handled. 'hosted' (default): an in-network voice assistant (cascade STT → LLM → TTS) is the brain. 'manual': your own LLM is the brain — Saperly forwards text turns and executes the directives you return. Audio stays in-network in both modes.

backend'network' | 'openai_realtime' nullable

The hosted brain backend. Today only 'network' is available; 'openai_realtime' is disabled and rejected.

instructionsstring nullable

The system prompt that defines the assistant's behavior.

languagestring nullable

The spoken language as a BCP-47 tag (e.g. "en", "es", "en-US"). Hosted: the in-network transcription hint. Manual: the Conversation Relay language (steers in-network transcription + the spoken voice). Discover values from GET /languages. Send "" to clear it back to auto-detect.

complianceEnabledboolean nullable

Toggle the do-not-message tool + the TCPA disclosure opener.

smsAutoReplyboolean nullable

Hosted-line opt-in to auto-answer inbound SMS with the model. Default off.

disclosurestring nullable

The TCPA notice spoken first, uninterruptibly, when compliance is on.

manualWebhookUrlstring nullable

Manual-mode webhook-brain URL. Only meaningful for manual mode; send "" to clear it.

Response

Success

idstring required

namestring required

mode'hosted' | 'manual' required

instructionsstring required

languagestring nullable required

complianceEnabledboolean required

smsAutoReplyboolean required

disclosurestring required

recordingEnabledboolean required

manualSecretstring nullable required

manualWebhookUrlstring nullable required

createdAtstring required

backend'network' | 'openai_realtime' required

Changes

No recorded changes to this operation across all 1 revision of this API.