Release a line

DELETE

https://saperly.com/api/v1/lines/:id

DELETE

/api/v1/lines/:id

1 const url = 'https://saperly.com/api/v1/lines/id';
2 const options = {
3   method: 'DELETE',
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": "+14155552671",
5     "display_name": "Support Line",
6     "name": "Customer Support",
7     "mode": "audio",
8     "audio_handler_url": "wss://audio-handler.saperly.com/lines/3fa85f64-5717-4562-b3fc-2c963f66afa6",
9     "webhook_url": "https://hooks.saperly.com/lines/3fa85f64-5717-4562-b3fc-2c963f66afa6/webhook",
10     "status_callback_url": "https://callbacks.saperly.com/lines/3fa85f64-5717-4562-b3fc-2c963f66afa6/status",
11     "compliance_enabled": true,
12     "system_prompt": "Welcome to the customer support line. How can I assist you today?",
13     "begin_message": "Hello! This is your support agent speaking.",
14     "voice": "elevenlabs-voice-1234abcd",
15     "context_limit": 20,
16     "recording_enabled": true,
17     "status": "released",
18     "environment": "live",
19     "created_at": "2024-01-15T09:30:00Z"
20   }
21 }

Soft-releases the line and returns the phone number to the carrier. The line will no longer accept or make calls.

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

Response

Line released

lineobject

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error