Update an outbound SIP trunk

PATCH

https://api.smallest.ai/atoms/v1/sip-trunk/outbound/:trunkId

Partial update; address and transport cannot be changed (delete and recreate instead). Removing a caller ID still used by a live campaign, as an agent’s transfer source, or attached as an agent’s caller ID returns 409 naming what uses it. Updating cpsLimit applies to every trunk on the same carrier address.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

trunkIdstringRequired

Request

All fields optional; only the fields present are updated. address and transport are not accepted. An empty body returns 400 (“Nothing to update”); numbers: [] returns 400 (“An outbound trunk needs at least one caller ID number”).

namestringOptional<=120 characters

numberslist of stringsOptional

Replaces the caller-ID list. E.164 with leading +.

mediaEncryptionenumOptional

Allowed values:

destinationCountrystringOptional=2 characters

cpsLimitintegerOptional1-50

authUsernamestringOptional

authPasswordstringOptional

Response

Updated trunk

statusbooleanOptional

dataobjectOptional

Errors

404

Not Found Error

409

Conflict Error

1	import requests
2
3	url = "https://api.smallest.ai/atoms/v1/sip-trunk/outbound/trunkId"
4
5	payload = {}
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.patch(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"status": true,
3	"data": {
4	"_id": "string",
5	"livekitTrunkId": "string",
6	"name": "string",
7	"address": "string",
8	"transport": "auto",
9	"numbers": [
10	"string"
11	],
12	"mediaEncryption": "disable",
13	"cpsLimit": 1,
14	"authUsername": "string",
15	"isActive": true,
16	"createdAt": "2024-01-15T09:30:00Z",
17	"updatedAt": "2024-01-15T09:30:00Z"
18	}
19	}