Update a line | Saperly Docs

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.

Allowed values:

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

ElevenLabs voice ID from GET /v1/voices

context_limitinteger or nullOptional1-50

Number of conversation turns to include as context

recording_enabledbooleanOptional

Whether to record calls on this line

Response

Line updated

lineobject

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	const url = 'https://saperly.com/api/v1/lines/id';
2	const options = {
3	method: 'PATCH',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"line": {
3	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"phone_number": "+15551234567",
5	"display_name": "Support Line",
6	"name": "Customer Support",
7	"mode": "audio",
8	"audio_handler_url": "wss://audio-handler.saperly.com/stream/3fa85f64-5717-4562-b3fc-2c963f66afa6",
9	"webhook_url": "https://hooks.saperly.com/call-events",
10	"status_callback_url": "https://hooks.saperly.com/status-updates",
11	"compliance_enabled": true,
12	"system_prompt": "You are a helpful AI assistant for customer support calls.",
13	"begin_message": "Hello, thank you for calling customer support. How can I assist you today?",
14	"voice": "elevenlabs-voice-1234abcd",
15	"context_limit": 10,
16	"recording_enabled": true,
17	"status": "provisioning",
18	"environment": "live",
19	"created_at": "2024-01-15T09:30:00Z"
20	}
21	}