Update a line | Saperly Docs

const url = 'https://saperly.com/api/v1/lines/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "line": {
    "id": "string",
    "phone_number": "+15551234567",
    "display_name": "string",
    "name": "string",
    "mode": "audio",
    "audio_handler_url": "string",
    "webhook_url": "string",
    "status_callback_url": "string",
    "compliance_enabled": true,
    "system_prompt": "string",
    "begin_message": "string",
    "voice": "string",
    "context_limit": 1,
    "recording_enabled": true,
    "language": "multi",
    "endpointing_ms": 1,
    "status": "provisioning",
    "environment": "live",
    "created_at": "2024-01-15T09:30:00Z"
  }
}

Updates one or more fields on a line. Only provided fields are changed, with one mode-switch exception: switching mode to audio while webhook_url is currently set implicitly clears webhook_url to null (so the SMS webhook route does not keep delivering to a URL the line no longer uses). To preserve webhook_url across an audio-mode switch, pass it explicitly in the same PATCH body.

Updates one or more fields on a line. Only provided fields are changed, with one mode-switch exception: switching `mode` to `audio` while `webhook_url` is currently set implicitly clears `webhook_url` to null (so the SMS webhook route does not keep delivering to a URL the line no longer uses). To preserve `webhook_url` across an audio-mode switch, pass it explicitly in the same PATCH body.

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Path parameters

idstringRequiredformat: "uuid"

Line ID

Request

This endpoint expects an object.

namestringOptional>=1 character

Human-readable name for the line

modeenumOptional

Switch the line’s transport. Switching to audio while the line currently has a webhook_url set implicitly clears webhook_url to null unless webhook_url is also passed in this same request.

audio_handler_urlstring or nullOptionalformat: "uri"

WebSocket URL for audio streaming (must be wss://)

webhook_urlstring or nullOptionalformat: "uri"

HTTPS URL to receive call events

status_callback_urlstring or nullOptionalformat: "uri"

HTTPS URL for call status updates

compliance_enabledbooleanOptional

Whether to enforce compliance checks

system_promptstring or nullOptional1-4000 characters

System prompt for hosted mode AI conversations

begin_messagestring or nullOptional1-500 characters

First message spoken by the AI when a call connects

voicestring or nullOptional

Saperly voice slug from GET /v1/voices (e.g. “aria”, “hebrew-warm”)

context_limitinteger or nullOptional1-50

Number of conversation turns to include as context

recording_enabledbooleanOptional

Whether to record calls on this line

languageenumOptional

v0.5.10. Update the Deepgram STT language pin. Pass multi to clear the pin. Rejected with HTTP 400 hosted_mode_language_pinning_unsupported on hosted-mode lines (current OR persisted mode — switching to hosted in this same request also clears any previously-set language to multi).

endpointing_msinteger or nullOptional100-2000

v0.5.10. Update the per-line endpointing override. Pass null to revert to the platform default (~700ms). Rejected with HTTP 400 hosted_mode_language_pinning_unsupported on hosted-mode lines.

Response

Line updated

lineobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error