Switch API reference

Switch: customer trunks

Customer trunks: addressing, credentials, limits, readiness and approvals.

48 operationsBase URL https://packetexchange.io/api/v1Postman collection

BrowseSwitch: customer trunks

List the trunk authentication methods available to you

GET/api/v1/switch/customer-trunks/auth-modes

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

For each method: what the customer must send and what the switch checks. Methods the platform cannot honour for you are omitted.

Response 200

Field	Type	Description
`data`required	object[]	-
`mode`requireddata[].mode	string	-One of `ip`, `credentials`, `ip_and_credentials`, `registration`, `certificate`
`title`requireddata[].title	string	-
`summary`requireddata[].summary	string	-
`sends`requireddata[].sends	string[]	What the customer must send
`checks`requireddata[].checks	string[]	What the switch checks on every call
`requires`requireddata[].requires	string[]	-One of `addresses`, `credentials`
`needsPlatformSupport`data[].needsPlatformSupport	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Update a Switch customer trunk

PATCH/api/v1/switch/customer-trunks/{trunkId}

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Setting status to disabled stops new calls but keeps the trunk configurable. A sipPassword sent here is echoed back once. Archived trunks are frozen: restore first. Send X-If-Unchanged-Since: <updatedAt you loaded> to have the save refused with 409 STALE_WRITE if someone changed the record since.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`label`	string	-max 120 chars
`authMode`	string	What the customer must present; the service refuses a mode the trunk is not configured forOne of `ip`, `credentials`, `ip_and_credentials`, `registration`, `certificate`
`sipUsername`	string \| null	-max 64 chars
`sipPassword`	string \| null	-max 64 chars
`maxConcurrentCalls`	integer \| null	-0 to 100000
`maxCps`	integer \| null	-0 to 10000
`markupPct`	number \| null	-0 to 10000
`billingIncrement`	string \| null	-max 10 chars
`blockedPrefixes`	string \| null	-max 8000 chars
`status`	string	-One of `active`, `disabled`
`mediaMode`	string	-One of `proxy`, `direct`
`techPrefix`	string \| null	-max 24 chars
`cliRewrite`	object \| null	-
`mode`cliRewrite.mode	string	-One of `pattern`
`value`cliRewrite.value	string	-max 24 chars
`strip`cliRewrite.strip	integer	-0 to 15
`add`cliRewrite.add	string	-max 12 chars
`match`cliRewrite.match	string	-max 200 chars
`replace`cliRewrite.replace	string	-max 200 chars
`allowedPrefixes`	string[] \| null	-
`allowedCountries`	string[] \| null	-
`blockedCountries`	string[] \| null	-
`maxCallDurationSeconds`	integer \| null	-1 to 21600
`requireCli`	boolean	-
`allowedClis`	string[] \| null	-
`marginProtectionMode`	string	-One of `off`, `monitor`, `enforce`
`minMarginPct`	number \| null	-0 to 99.999
`minMarginAbs`	number \| null	-0 to 1000
`maxLossPerMinute`	number \| null	-0 to 1000
`dailyLossLimit`	number \| null	Warns only; never blocks0 to 10000000
`dailyLossLimitPct`	number \| null	-0 to 100000

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`subAccountId`requireddata.subAccountId	string (uuid)	The customer this trunk belongs to
`label`requireddata.label	string	-
`status`requireddata.status	string	-One of `active`, `disabled`, `archived`
`authMode`data.authMode	string	-One of `ip`, `credentials`, `ip_and_credentials`, `registration`, `certificate`
`sipUsername`requireddata.sipUsername	string \| null	-
`sipPasswordSet`requireddata.sipPasswordSet	boolean	-
`maxConcurrentCalls`requireddata.maxConcurrentCalls	integer \| null	Null inherits the customer ceiling
`maxCps`requireddata.maxCps	integer \| null	-
`markupPct`requireddata.markupPct	string \| null	-
`billingIncrement`requireddata.billingIncrement	string \| null	-
`techPrefix`requireddata.techPrefix	string \| null	-
`mediaMode`data.mediaMode	string	-One of `proxy`, `direct`
`cliRewrite`requireddata.cliRewrite	object \| null	-
`allowedPrefixes`requireddata.allowedPrefixes	string[] \| null	-
`allowedCountries`requireddata.allowedCountries	string[] \| null	-
`blockedCountries`requireddata.blockedCountries	string[] \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X PATCH "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Acme",
  "authMode": "ip"
}'

Run it here with a test key.

Delete an unused Switch customer trunk

DELETE/api/v1/switch/customer-trunks/{trunkId}

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Refused, naming the dependency, once the trunk has carried traffic, holds rates or routing, or is the customer's last trunk. Archive it instead. Check removability first.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`deleted`requireddata.deleted	boolean	-One of `true`
`label`requireddata.label	string	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

Show the configuration actually in force on a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/effective-config

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Every setting with the value a call would meet and the level it was inherited from, resolved by the same code as the call path. Read-only.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`trunk`requireddata.trunk	object	-
`id`requireddata.trunk.id	string (uuid)	-
`label`requireddata.trunk.label	string	-
`status`requireddata.trunk.status	string	-
`customerId`requireddata.trunk.customerId	string (uuid)	-
`customerLabel`requireddata.trunk.customerLabel	string	-
`sections`requireddata.sections	object[]	Each setting with the value in force and the level it came from
`capacity`requireddata.capacity	object	-
`limits`requireddata.capacity.limits	object[]	-
`refusals`data.capacity.refusals	any	-
`checkOrder`requireddata.capacity.checkOrder	string[]	-
`note`requireddata.capacity.note	string	-
`readOnly`requireddata.readOnly	boolean	-One of `true`

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/effective-config" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Archive a Switch customer trunk

POST/api/v1/switch/customer-trunks/{trunkId}/archive

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Takes the trunk out of service and out of operational lists, and freezes it. Nothing is destroyed; restore brings it back disabled.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`reason`	string \| null	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as SwitchCustomerTrunk, shown earlier on this page.

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/archive" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Example"
}'

Run it here with a test key.

Restore an archived Switch customer trunk

POST/api/v1/switch/customer-trunks/{trunkId}/restore

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Comes back disabled, so no traffic starts until you enable it.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as SwitchCustomerTrunk, shown earlier on this page.

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

Preview what disabling, enabling or archiving a trunk would do

GET/api/v1/switch/customer-trunks/{trunkId}/service-impact

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Live channels, recent traffic, whether it is the customer's last enabled trunk, and what survives.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`action`	query	string	Default disableOne of disable, enable, archive, restore

Response 200

Field	Type	Description
`data`required	object	-
`action`requireddata.action	string	-One of `disable`, `enable`, `archive`, `restore`
`trunk`requireddata.trunk	object	-
`id`requireddata.trunk.id	string (uuid)	-
`label`requireddata.trunk.label	string	-
`status`requireddata.trunk.status	string	-
`customer`requireddata.customer	object	-
`id`requireddata.customer.id	string (uuid)	-
`label`requireddata.customer.label	string	-
`status`requireddata.customer.status	string	-
`liveChannels`requireddata.liveChannels	integer	-
`last24h`requireddata.last24h	object	-
`siblingsEnabled`requireddata.siblingsEnabled	integer	-
`stopsCustomer`requireddata.stopsCustomer	boolean	True when this is the customer's last enabled trunk
`reversible`requireddata.reversible	boolean	-
`consequences`requireddata.consequences	string[]	-
`preserved`requireddata.preserved	string[]	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Check whether a Switch customer trunk can be deleted

GET/api/v1/switch/customer-trunks/{trunkId}/removability

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`trunk`requireddata.trunk	object	-
`id`requireddata.trunk.id	string (uuid)	-
`label`requireddata.trunk.label	string	-
`status`requireddata.trunk.status	string	-
`deletable`requireddata.deletable	boolean	-
`blockers`requireddata.blockers	object[]	-
`kind`requireddata.blockers[].kind	string	-One of `traffic`, `refusals`, `billing`, `rates`, `routing`, `audit`, `last_trunk`
`count`requireddata.blockers[].count	integer	-
`detail`requireddata.blockers[].detail	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Clone a Switch customer trunk

POST/api/v1/switch/customer-trunks/{trunkId}/clone

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Copies the trunk's settings and sell rates to a new trunk on the same customer.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`label`required	string	-max 120 chars

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`subAccountId`requireddata.subAccountId	string (uuid)	The customer this trunk belongs to
`label`requireddata.label	string	-
`status`requireddata.status	string	-One of `active`, `disabled`, `archived`
`authMode`data.authMode	string	-One of `ip`, `credentials`, `ip_and_credentials`, `registration`, `certificate`
`sipUsername`requireddata.sipUsername	string \| null	-
`sipPasswordSet`requireddata.sipPasswordSet	boolean	-
`maxConcurrentCalls`requireddata.maxConcurrentCalls	integer \| null	Null inherits the customer ceiling
`maxCps`requireddata.maxCps	integer \| null	-
`markupPct`requireddata.markupPct	string \| null	-
`billingIncrement`requireddata.billingIncrement	string \| null	-
`techPrefix`requireddata.techPrefix	string \| null	-
`mediaMode`data.mediaMode	string	-One of `proxy`, `direct`
`cliRewrite`requireddata.cliRewrite	object \| null	-
`allowedPrefixes`requireddata.allowedPrefixes	string[] \| null	-
`allowedCountries`requireddata.allowedCountries	string[] \| null	-
`blockedCountries`requireddata.blockedCountries	string[] \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`copiedRates`requireddata.copiedRates	integer	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/clone" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Acme"
}'

Run it here with a test key.

List a trunk's allowed source addresses

GET/api/v1/switch/customer-trunks/{trunkId}/ips

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`cidr`requireddata[].cidr	string	-
`description`requireddata[].description	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Allow a source address on a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/ips

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Stored in canonical form. Refused when it cannot be saved (see addresses/preview); overlaps with other entries are returned in conflicts. Applies to new calls only.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`cidr`required	string	An IP address or CIDR blockmax 64 chars
`description`	string	-max 160 chars

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`cidr`requireddata.cidr	string	-
`description`requireddata.description	string \| null	-
`conflicts`requireddata.conflicts	object[]	-
`kind`requireddata.conflicts[].kind	string	-
`otherId`requireddata.conflicts[].otherId	string (uuid)	-
`otherCidr`requireddata.conflicts[].otherCidr	string	-
`otherTrunkId`requireddata.conflicts[].otherTrunkId	string (uuid) \| null	-
`otherTrunkLabel`requireddata.conflicts[].otherTrunkLabel	string \| null	-
`otherCustomerId`requireddata.conflicts[].otherCustomerId	string (uuid) \| null	-
`otherCustomerLabel`requireddata.conflicts[].otherCustomerLabel	string \| null	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/ips" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cidr": "<cidr>"
}'

Run it here with a test key.

List a trunk's addresses with overlaps and customer-level entries

GET/api/v1/switch/customer-trunks/{trunkId}/addresses

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

The richer form of /ips: each entry with its canonical form and every overlapping entry on your switch, including addresses added on the customer.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`trunkId`requireddata.trunkId	string (uuid)	-
`trunkLabel`requireddata.trunkLabel	string	-
`customerId`requireddata.customerId	string (uuid)	-
`entries`requireddata.entries	object[]	-
`id`requireddata.entries[].id	string (uuid)	-
`cidr`requireddata.entries[].cidr	string	-
`canonical`requireddata.entries[].canonical	string \| null	-
`description`requireddata.entries[].description	string \| null	-
`ambiguous`data.entries[].ambiguous	boolean	-
`customerLevel`requireddata.customerLevel	object[]	Addresses added on the customer, which apply to every trunk
`ambiguousCount`requireddata.ambiguousCount	integer	-
`activation`requireddata.activation	object	-
`appliesTo`requireddata.activation.appliesTo	string	-One of `new_requests`
`affectsCallsInProgress`requireddata.activation.affectsCallsInProgress	boolean	-One of `false`
`note`requireddata.activation.note	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Preview an address before allowing it on a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/addresses/preview

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Read-only: the canonical form, size, whether it would be refused, and what it overlaps.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`cidr`required	string	-max 64 chars

Response 200

Field	Type	Description
`data`required	object	-
`canonical`requireddata.canonical	string	-
`prefixBits`requireddata.prefixBits	integer	-
`addressCount`requireddata.addressCount	number	-
`blocked`requireddata.blocked	object \| null	Set when the address cannot be saved at all
`reason`requireddata.blocked.reason	string	-
`conflicts`requireddata.conflicts	object[]	-
`kind`requireddata.conflicts[].kind	string	-
`otherId`requireddata.conflicts[].otherId	string (uuid)	-
`otherCidr`requireddata.conflicts[].otherCidr	string	-
`otherTrunkId`requireddata.conflicts[].otherTrunkId	string (uuid) \| null	-
`otherTrunkLabel`requireddata.conflicts[].otherTrunkLabel	string \| null	-
`otherCustomerId`requireddata.conflicts[].otherCustomerId	string (uuid) \| null	-
`otherCustomerLabel`requireddata.conflicts[].otherCustomerLabel	string \| null	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/addresses/preview" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cidr": "<cidr>"
}'

Run it here with a test key.

Test a caller-ID rewrite rule against a sample number

POST/api/v1/switch/customer-trunks/cli-rewrite/preview

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Dry run; saves nothing and needs no trunk.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Request body (application/json)

Field	Type	Description
`rule`	any	A cliRewrite rule as used on a trunk
`sample`required	string	-max 32 chars

Response 200

Field	Type	Description
`data`required	object	-
`ok`requireddata.ok	boolean	-
`result`requireddata.result	string \| null	-
`error`data.error	string	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/cli-rewrite/preview" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "<sample>"
}'

Run it here with a test key.

Remove an allowed source address from a trunk

DELETE/api/v1/switch/customer-trunks/{trunkId}/ips/{aclId}

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`aclId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`cidr`requireddata.cidr	string	-
`description`requireddata.description	string \| null	-
`deleted`requireddata.deleted	boolean	-One of `true`

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X DELETE "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/ips/<aclId>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Set routing on a Switch customer trunk

POST/api/v1/switch/customer-trunks/{trunkId}/routing

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Route group, failover group, dialplan, strategy or a direct supplier for this trunk. Send X-If-Unchanged-Since: <updatedAt you loaded> to have the save refused with 409 STALE_WRITE if someone changed the record since.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`routePlanId`	string (uuid) \| null	-
`failoverRoutePlanId`	string (uuid) \| null	-
`directRouteId`	string (uuid) \| null	-
`directVendorTrunkId`	string (uuid) \| null	-
`dialplanId`	string (uuid) \| null	-
`strategyOverride`	string \| null	-max 24 chars

Response 200

Field	Type	Description
`data`required	object	-
`subAccountId`requireddata.subAccountId	string (uuid)	-
`customerTrunkId`data.customerTrunkId	string (uuid) \| null	-
`dialplanId`requireddata.dialplanId	string (uuid) \| null	-
`routePlanId`requireddata.routePlanId	string (uuid) \| null	-
`failoverRoutePlanId`requireddata.failoverRoutePlanId	string (uuid) \| null	-
`strategyOverride`requireddata.strategyOverride	string \| null	-
`directRouteId`requireddata.directRouteId	string (uuid) \| null	-
`directVendorTrunkId`requireddata.directVendorTrunkId	string (uuid) \| null	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/routing" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "routePlanId": "<routePlanId>",
  "failoverRoutePlanId": "<failoverRoutePlanId>"
}'

Run it here with a test key.

Show the route wired up for a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/routing-path

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Customer, trunk, fixed route or route group, then supplier trunks, with ids. For what a specific number would do, use /switch/routing/preview.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`customer`requireddata.customer	object \| null	-
`id`requireddata.customer.id	string (uuid)	-
`label`requireddata.customer.label	string	-
`customerTrunk`requireddata.customerTrunk	object	-
`id`requireddata.customerTrunk.id	string (uuid)	-
`label`requireddata.customerTrunk.label	string	-
`status`requireddata.customerTrunk.status	string	-
`techPrefix`requireddata.customerTrunk.techPrefix	string \| null	-
`kind`requireddata.kind	string	Fixed route, route group, or nothing wiredOne of `fixed`, `group`, `none`
`fixed`requireddata.fixed	object \| null	-
`group`requireddata.group	object \| null	-
`failoverGroup`requireddata.failoverGroup	object \| null	-
`dialplan`requireddata.dialplan	object \| null	-
`id`requireddata.dialplan.id	string (uuid)	-
`name`requireddata.dialplan.name	string	-
`strategyOverride`requireddata.strategyOverride	string \| null	-
`unrouted`requireddata.unrouted	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Reveal a Switch customer trunk's SIP credentials

GET/api/v1/switch/customer-trunks/{trunkId}/credentials

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Returns the current username and password without changing them. Every reveal is recorded in the audit log.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`sipUsername`requireddata.sipUsername	string \| null	-
`sipPassword`requireddata.sipPassword	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get a trunk's credential history and last successful authentication

GET/api/v1/switch/customer-trunks/{trunkId}/credential-status

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Everything about the credential except its value: username, storage, last change and reveal, and the last call identified with it.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`trunkId`requireddata.trunkId	string (uuid)	-
`trunkLabel`requireddata.trunkLabel	string	-
`customerId`requireddata.customerId	string (uuid)	-
`customerLabel`requireddata.customerLabel	string \| null	-
`username`requireddata.username	string \| null	-
`passwordSet`requireddata.passwordSet	boolean	-
`storage`requireddata.storage	object	-
`sealed`requireddata.storage.sealed	boolean	-
`note`requireddata.storage.note	string	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`lastChange`data.lastChange	any	-
`lastReveal`data.lastReveal	any	-
`historyAvailable`requireddata.historyAvailable	boolean	-
`lastSuccessfulAuth`requireddata.lastSuccessfulAuth	object \| null	-
`at`requireddata.lastSuccessfulAuth.at	string	-
`sourceIp`requireddata.lastSuccessfulAuth.sourceIp	string \| null	-
`sourceIsRegistered`requireddata.lastSuccessfulAuth.sourceIsRegistered	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/credential-status" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Record that a trunk credential was copied

POST/api/v1/switch/customer-trunks/{trunkId}/credentials/copied

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Writes an audit entry only. Call it when your interface copies a credential to the clipboard.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`field`	string	-default "sipPassword"One of `sipPassword`, `sipUsername`

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Response 204

Recorded.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/credentials/copied" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "field": "sipPassword"
}'

Run it here with a test key.

Replace a Switch customer trunk's SIP password

POST/api/v1/switch/customer-trunks/{trunkId}/sip-password

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Generate one, or set one by hand with mode: "manual". The new password is returned ONCE and the old one stops working immediately (no overlap window).

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`mode`	string	-default "generate"One of `generate`, `manual`
`password`	string	Required when mode is manualmax 128 chars

Response 200

Field	Type	Description
`data`required	object	-
`trunkId`requireddata.trunkId	string (uuid)	-
`username`requireddata.username	string \| null	-
`password`requireddata.password	string	The new password in plain text. Returned ONCE, here.
`mode`requireddata.mode	string	-One of `generate`, `manual`
`changedAt`requireddata.changedAt	string (date-time)	ISO-8601 timestamp (UTC)
`overlapWindow`requireddata.overlapWindow	enum \| null	There is no grace period: the old password stops working immediatelyOne of `null`
`note`requireddata.note	string	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/sip-password" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "generate",
  "password": "correct-horse-battery-staple"
}'

Run it here with a test key.

List trunk configuration changes awaiting or after review

GET/api/v1/switch/trunk-changes

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`	query	string (uuid)	-
`status`	query	string	Comma-separated statuses, e.g. pending,approved

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`vendorTrunkId`requireddata[].vendorTrunkId	string (uuid)	-
`trunkLabel`requireddata[].trunkLabel	string \| null	-
`status`requireddata[].status	string	-
`fields`requireddata[].fields	string[]	-
`changes`requireddata[].changes	object[]	Secret fields show "(secret)", never their value
`field`requireddata[].changes[].field	string	-
`from`data[].changes[].from	any	-
`to`data[].changes[].to	any	-
`patch`requireddata[].patch	object	-
`beforeValues`requireddata[].beforeValues	object	-
`note`requireddata[].note	string \| null	-
`requestedBy`requireddata[].requestedBy	string (uuid)	-
`requestedByEmail`requireddata[].requestedByEmail	string \| null	-
`requestedAt`requireddata[].requestedAt	string (date-time)	ISO-8601 timestamp (UTC)
`reviewedBy`requireddata[].reviewedBy	string (uuid) \| null	-
`reviewedAt`requireddata[].reviewedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`reviewNote`requireddata[].reviewNote	string \| null	-
`appliedAt`requireddata[].appliedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Approve and apply a trunk configuration change

POST/api/v1/switch/trunk-changes/{id}/approve

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

applied is the trunk after the change, redacted like every trunk read (sipAuthPasswordSet / smppPasswordSet instead of the secrets). driftedSinceRequest lists fields that changed on the trunk after the request was made.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`note`	string	-

Response 200

Field	Type	Description
`data`required	object	-
`applied`requireddata.applied	object	-
`driftedSinceRequest`requireddata.driftedSinceRequest	string[]	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/trunk-changes/<id>/approve" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Example"
}'

Run it here with a test key.

Reject a trunk configuration change

POST/api/v1/switch/trunk-changes/{id}/reject

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`note`	string	-

Response 200

Field	Type	Description
`data`required	object	-
`rejected`requireddata.rejected	boolean	-One of `true`

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/trunk-changes/<id>/reject" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Example"
}'

Run it here with a test key.

Withdraw your own pending trunk change

POST/api/v1/switch/trunk-changes/{id}/withdraw

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`withdrawn`requireddata.withdrawn	boolean	-One of `true`

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get whether supplier trunk changes need approval

GET/api/v1/switch/trunk-approval-setting

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object	-
`requireTrunkApproval`requireddata.requireTrunkApproval	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Turn supplier trunk change approval on or off

POST/api/v1/switch/trunk-approval-setting

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Request body (application/json)

Field	Type	Description
`requireTrunkApproval`required	boolean	-

Response 200

Field	Type	Description
`data`required	object	-
`requireTrunkApproval`requireddata.requireTrunkApproval	boolean	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/trunk-approval-setting" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requireTrunkApproval": true
}'

Run it here with a test key.

Get whether trunk readiness blocks first activation

GET/api/v1/switch/trunk-readiness-setting

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object	-
`requireTrunkReadiness`requireddata.requireTrunkReadiness	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Turn the trunk readiness gate on or off

POST/api/v1/switch/trunk-readiness-setting

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

When on, it can refuse only the first-ever activation of a new trunk; existing trunks are grandfathered and bundle trunks are exempt.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Request body (application/json)

Field	Type	Description
`requireTrunkReadiness`required	boolean	-

Response 200

Field	Type	Description
`data`required	object	-
`requireTrunkReadiness`requireddata.requireTrunkReadiness	boolean	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/trunk-readiness-setting" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requireTrunkReadiness": true
}'

Run it here with a test key.

Get the sell deck in force on a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/sell-deck

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

The resolved deck, plus the customer and system defaults it did not pick, and a sentence saying which won.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`deck`requireddata.deck	object \| null	-
`id`requireddata.deck.id	string (uuid)	-
`name`requireddata.deck.name	string	-
`version`requireddata.deck.version	integer	-
`status`requireddata.deck.status	string	-
`currency`requireddata.deck.currency	string	-
`isSystemDefault`requireddata.deck.isSystemDefault	boolean	-
`defaultRatePerUnit`requireddata.deck.defaultRatePerUnit	number \| null	USD per minute for destinations the deck does not list; null = refuse them
`charging`requireddata.deck.charging	object	-
`mode`requireddata.mode	string	-
`choice`requireddata.choice	string	Which rule won: the trunk, the customer default or the system default
`bypassesCustomerDefault`requireddata.bypassesCustomerDefault	boolean	-
`customerDefault`requireddata.customerDefault	object \| null	Same fields as SwitchCustomerSellDeckRef, shown earlier on this page.
`systemDefault`requireddata.systemDefault	object \| null	Same fields as SwitchCustomerSellDeckRef, shown earlier on this page.
`liveRowCount`requireddata.liveRowCount	integer	-
`explanation`requireddata.explanation	string	-
`problem`requireddata.problem	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Assign a sell deck to a trunk

PUT/api/v1/switch/customer-trunks/{trunkId}/sell-deck

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Without confirm: true nothing changes and the response shows what would be in force. With it, the trunk reprices from the next call.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`mode`required	string	How a trunk picks its sell deckOne of `customer_default`, `system_default`, `deck`, `none`
`deckId`	string (uuid) \| null	-
`confirm`	boolean	-
`reason`	string	-

Response 200

Field	Type	Description
`data`required	object	-
`changed`data.changed	boolean	-One of `true`
`before`data.before	object	Same fields as SwitchTrunkEffectiveSellDeck, shown earlier on this page.
`wouldBe`data.wouldBe	object	-
`mode`requireddata.wouldBe.mode	string	-
`deck`requireddata.wouldBe.deck	object \| null	Same fields as SwitchCustomerSellDeckRef, shown earlier on this page.
`rates`data.wouldBe.rates	any	-
`bypassesCustomerDefault`requireddata.wouldBe.bypassesCustomerDefault	boolean	-
`warning`requireddata.wouldBe.warning	string \| null	-
`defaultRate`requireddata.wouldBe.defaultRate	number \| null	-
`unlistedDestinations`requireddata.wouldBe.unlistedDestinations	string	-
`after`data.after	object	Same fields as SwitchTrunkEffectiveSellDeck, shown earlier on this page.

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X PUT "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/sell-deck" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "customer_default"
}'

Run it here with a test key.

Preview a sell-deck assignment for a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/sell-deck/preview

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

What would be in force under a mode, computed by the same resolver. Writes nothing.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`mode`	query	string	Default customer_defaultOne of customer_default, system_default, deck, none
`deckId`	query	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`mode`requireddata.mode	string	-
`deck`requireddata.deck	object \| null	Same fields as SwitchCustomerSellDeckRef, shown earlier on this page.
`rates`data.rates	any	-
`bypassesCustomerDefault`requireddata.bypassesCustomerDefault	boolean	-
`warning`requireddata.warning	string \| null	-
`defaultRate`requireddata.defaultRate	number \| null	-
`unlistedDestinations`requireddata.unlistedDestinations	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/sell-deck/preview" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

List a trunk's sell rates with buy cost and margin

GET/api/v1/switch/customer-trunks/{trunkId}/rates

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`search`	query	string	Prefix or destination text
`limit`	query	integer	-
`offset`	query	integer	-
`view`	query	string	Default currentOne of current, scheduled, discontinued, expiring, all
`origin`	query	string	-One of any, origin_only, destination_only
`increment`	query	string	-One of any, custom, inherited
`cost`	query	string	-One of any, missing
`margin`	query	string	-One of any, thin, negative

Response 200

Field	Type	Description
`data`required	object	-
`rows`requireddata.rows	object[]	-
`id`requireddata.rows[].id	string (uuid)	-
`subAccountId`requireddata.rows[].subAccountId	string (uuid)	-
`customerTrunkId`requireddata.rows[].customerTrunkId	string (uuid) \| null	-
`prefix`requireddata.rows[].prefix	string	-
`originPrefix`requireddata.rows[].originPrefix	string	"" = any origin
`ratePerUnit`requireddata.rows[].ratePerUnit	money	Sell price per minute, 6-decimal USD string USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata.rows[].billingIncrement	string \| null	-
`status`requireddata.rows[].status	string	active, pending (scheduled) or discontinued
`effectiveFrom`requireddata.rows[].effectiveFrom	string (date-time)	ISO-8601 timestamp (UTC)
`endDate`requireddata.rows[].endDate	string (date-time) \| null	ISO-8601 timestamp (UTC)
`buyCost`requireddata.rows[].buyCost	number \| null	Best eligible buy cost per minute (USD number); null = no supplier prices it
`marginPct`requireddata.rows[].marginPct	number \| null	-
`thin`requireddata.rows[].thin	boolean	-
`negative`requireddata.rows[].negative	boolean	-
`costSupplier`requireddata.rows[].costSupplier	string \| null	-
`costSource`requireddata.rows[].costSource	string	-
`costMatchedPrefix`requireddata.rows[].costMatchedPrefix	string \| null	-
`costNote`requireddata.rows[].costNote	string \| null	-
`total`requireddata.total	integer	-
`totalIsPageScoped`requireddata.totalIsPageScoped	boolean	True when a cost or margin filter narrowed the page, so `total` counts this page only
`limit`requireddata.limit	integer	-
`offset`requireddata.offset	integer	-
`view`requireddata.view	string	-
`summary`requireddata.summary	object	-
`prefixes`requireddata.summary.prefixes	integer	-
`blendedMarginPct`requireddata.summary.blendedMarginPct	number \| null	-
`thinCount`requireddata.summary.thinCount	integer	-
`negativeCount`requireddata.summary.negativeCount	integer	-
`defaultRateCostCount`requireddata.summary.defaultRateCostCount	integer	-
`unpricedCount`requireddata.summary.unpricedCount	integer	-
`basis`data.basis	any	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Add or replace one sell rate on a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/rates

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`prefix`required	string	-max 24 chars
`rate`required	number	USD per minutemin 0
`origin`	string	-max 24 chars
`billingIncrement`	string	-max 10 chars

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`subAccountId`requireddata.subAccountId	string (uuid)	-
`customerTrunkId`requireddata.customerTrunkId	string (uuid) \| null	-
`prefix`requireddata.prefix	string	-
`originPrefix`requireddata.originPrefix	string	"" = any origin
`ratePerUnit`requireddata.ratePerUnit	money	Sell price per minute, 6-decimal USD string USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata.billingIncrement	string \| null	-
`status`requireddata.status	string	active, pending (scheduled) or discontinued
`effectiveFrom`requireddata.effectiveFrom	string (date-time)	ISO-8601 timestamp (UTC)
`endDate`requireddata.endDate	string (date-time) \| null	ISO-8601 timestamp (UTC)

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prefix": "44",
  "rate": 1
}'

Run it here with a test key.

Count a trunk's sell rates by view

GET/api/v1/switch/customer-trunks/{trunkId}/rates/counts

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`current`requireddata.current	integer	-
`scheduled`requireddata.scheduled	integer	-
`expiring`requireddata.expiring	integer	-
`discontinued`requireddata.discontinued	integer	-
`all`requireddata.all	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List upcoming sell-rate starts and ends on a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/rates/upcoming

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`subAccountId`requireddata[].subAccountId	string (uuid)	-
`customerTrunkId`requireddata[].customerTrunkId	string (uuid) \| null	-
`prefix`requireddata[].prefix	string	-
`originPrefix`requireddata[].originPrefix	string	"" = any origin
`ratePerUnit`requireddata[].ratePerUnit	money	Sell price per minute, 6-decimal USD string USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata[].billingIncrement	string \| null	-
`status`requireddata[].status	string	active, pending (scheduled) or discontinued
`effectiveFrom`requireddata[].effectiveFrom	string (date-time)	ISO-8601 timestamp (UTC)
`endDate`requireddata[].endDate	string (date-time) \| null	ISO-8601 timestamp (UTC)
`kind`requireddata[].kind	string	-One of `starts`, `ends`
`at`requireddata[].at	string (date-time) \| null	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List sell-rate discontinuation events on a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/rates/discontinuations

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object[]	-
`revisionId`requireddata[].revisionId	string (uuid) \| null	-
`discontinuedAt`requireddata[].discontinuedAt	string (date-time)	ISO-8601 timestamp (UTC)
`rows`requireddata[].rows	integer	-
`label`requireddata[].label	string	-
`effective`data[].effective	any \| null	-
`timezone`requireddata[].timezone	string \| null	-
`changeMode`requireddata[].changeMode	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/discontinuations" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Preview discontinuing a trunk's whole sell deck

POST/api/v1/switch/customer-trunks/{trunkId}/rates/discontinue-all/preview

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Omit the effective fields to act now. Send either effectiveFrom (an instant with an offset) or effectiveLocal plus timezone; a bare date is refused because midnight differs by country.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`effectiveFrom`	string	An instant with offset, e.g. "2026-10-01T00:00:00Z". A bare date is refused.max 40 chars
`effectiveLocal`	string	A wall-clock time, e.g. "2026-10-01T00:00"; requires `timezone`max 30 chars
`timezone`	string \| null	IANA zone, e.g. Europe/London; always recordedmax 64 chars

Response 200

Field	Type	Description
`data`required	object	-
`customerLabel`requireddata.customerLabel	string	-
`activeRates`requireddata.activeRates	integer	-
`scheduledRates`requireddata.scheduledRates	integer	-
`alreadyDiscontinued`requireddata.alreadyDiscontinued	integer	-
`endDate`requireddata.endDate	string (date-time)	ISO-8601 timestamp (UTC)
`immediate`requireddata.immediate	boolean	-
`timezone`requireddata.timezone	string \| null	-
`effectOnNewCalls`requireddata.effectOnNewCalls	string	-
`minutes30d`requireddata.minutes30d	number	-
`calls30d`requireddata.calls30d	integer	-
`revenue30d`requireddata.revenue30d	number	US dollars as a JSON number (computed figure)
`impactTruncated`requireddata.impactTruncated	boolean	-
`sample`requireddata.sample	object[]	-
`prefix`requireddata.sample[].prefix	string	-
`originPrefix`requireddata.sample[].originPrefix	string	-
`ratePerUnit`requireddata.sample[].ratePerUnit	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata.sample[].billingIncrement	string \| null	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/discontinue-all/preview" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "effectiveFrom": "<effectiveFrom>",
  "effectiveLocal": "<effectiveLocal>"
}'

Run it here with a test key.

Discontinue a trunk's whole sell deck

POST/api/v1/switch/customer-trunks/{trunkId}/rates/discontinue-all

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Nothing is deleted; priced calls keep their rate. Omit the effective fields to act now. Send either effectiveFrom (an instant with an offset) or effectiveLocal plus timezone; a bare date is refused because midnight differs by country.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`effectiveFrom`	string	An instant with offset, e.g. "2026-10-01T00:00:00Z". A bare date is refused.max 40 chars
`effectiveLocal`	string	A wall-clock time, e.g. "2026-10-01T00:00"; requires `timezone`max 30 chars
`timezone`	string \| null	IANA zone, e.g. Europe/London; always recordedmax 64 chars
`includeScheduled`	boolean	-

Response 200

Field	Type	Description
`data`required	object	-
`endDate`requireddata.endDate	string (date-time)	ISO-8601 timestamp (UTC)
`effective`data.effective	any	The moment described in words and in the recorded zone
`revisionId`data.revisionId	string (uuid) \| null	-
`discontinued`requireddata.discontinued	integer	-
`deleted`requireddata.deleted	integer	Deprecated alias of `discontinued`; nothing is deleted
`scheduledLeft`requireddata.scheduledLeft	integer	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/discontinue-all" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "effectiveFrom": "<effectiveFrom>",
  "effectiveLocal": "<effectiveLocal>"
}'

Run it here with a test key.

Discontinue one sell rate on a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/rates/{rateId}/discontinue

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Omit the effective fields to act now. Send either effectiveFrom (an instant with an offset) or effectiveLocal plus timezone; a bare date is refused because midnight differs by country.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`rateId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`effectiveFrom`	string	An instant with offset, e.g. "2026-10-01T00:00:00Z". A bare date is refused.max 40 chars
`effectiveLocal`	string	A wall-clock time, e.g. "2026-10-01T00:00"; requires `timezone`max 30 chars
`timezone`	string \| null	IANA zone, e.g. Europe/London; always recordedmax 64 chars

Response 200

Field	Type	Description
`data`required	object	-
`endDate`requireddata.endDate	string (date-time)	ISO-8601 timestamp (UTC)
`effective`data.effective	any	The moment described in words and in the recorded zone
`revisionId`data.revisionId	string (uuid) \| null	-
`discontinued`requireddata.discontinued	boolean	-One of `true`
`deleted`requireddata.deleted	boolean	Deprecated alias; the rate is discontinued, not deletedOne of `true`
`immediate`requireddata.immediate	boolean	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/<rateId>/discontinue" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "effectiveFrom": "<effectiveFrom>",
  "effectiveLocal": "<effectiveLocal>"
}'

Run it here with a test key.

Add or replace many sell rates on a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/rates/bulk

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`rows`required	object[]	-
`prefix`requiredrows[].prefix	string	-max 24 chars
`rate`requiredrows[].rate	number	-min 0
`origin`rows[].origin	string	-max 24 chars
`billingIncrement`rows[].billingIncrement	string	-max 10 chars

Response 200

Field	Type	Description
`data`required	object	-
`applied`requireddata.applied	integer	-
`revisionId`requireddata.revisionId	string (uuid) \| null	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/bulk" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "rows": [
    {
      "prefix": "44",
      "rate": 1
    }
  ]
}'

Run it here with a test key.

Discontinue one sell rate on a trunk now

DELETE/api/v1/switch/customer-trunks/{trunkId}/rates/{rateId}

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Kept for existing clients: the rate is discontinued immediately, not deleted.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`rateId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`endDate`requireddata.endDate	string (date-time)	ISO-8601 timestamp (UTC)
`effective`data.effective	any	The moment described in words and in the recorded zone
`revisionId`data.revisionId	string (uuid) \| null	-
`discontinued`requireddata.discontinued	boolean	-One of `true`
`deleted`requireddata.deleted	boolean	Deprecated alias; the rate is discontinued, not deletedOne of `true`
`immediate`requireddata.immediate	boolean	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X DELETE "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/<rateId>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Discontinue every sell rate on a trunk now

POST/api/v1/switch/customer-trunks/{trunkId}/rates/clear

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`endDate`requireddata.endDate	string (date-time)	ISO-8601 timestamp (UTC)
`effective`data.effective	any	The moment described in words and in the recorded zone
`revisionId`data.revisionId	string (uuid) \| null	-
`discontinued`requireddata.discontinued	integer	-
`deleted`requireddata.deleted	integer	Deprecated alias of `discontinued`; nothing is deleted
`scheduledLeft`requireddata.scheduledLeft	integer	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/clear" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

List scheduled (future-dated) sell rates on a trunk

GET/api/v1/switch/customer-trunks/{trunkId}/rates/scheduled

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object[]	Same fields as SwitchCustomerSellRate, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Schedule a future sell-rate change on a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/rates/schedule

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

The rate becomes active at the effective moment. Omit the effective fields to act now. Send either effectiveFrom (an instant with an offset) or effectiveLocal plus timezone; a bare date is refused because midnight differs by country.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`effectiveFrom`	string	An instant with offset, e.g. "2026-10-01T00:00:00Z". A bare date is refused.max 40 chars
`effectiveLocal`	string	A wall-clock time, e.g. "2026-10-01T00:00"; requires `timezone`max 30 chars
`timezone`	string \| null	IANA zone, e.g. Europe/London; always recordedmax 64 chars
`prefix`required	string	-max 24 chars
`rate`required	number	USD per minutemin 0
`origin`	string	-max 24 chars
`billingIncrement`	string	-max 10 chars

Response 201

Field	Type	Description
`data`required	object	Same fields as SwitchCustomerSellRate, shown earlier on this page.

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/schedule" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prefix": "44",
  "rate": 1
}'

Run it here with a test key.

Cancel a scheduled sell rate on a trunk

DELETE/api/v1/switch/customer-trunks/{trunkId}/rates/scheduled/{rateId}

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`rateId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`cancelled`requireddata.cancelled	boolean	-One of `true`

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X DELETE "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/scheduled/<rateId>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Reprice as a markup over buy cost from a trunk

POST/api/v1/switch/customer-trunks/{trunkId}/rates/apply-markup

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Applies to the customer's deck; on a single-trunk customer that is this trunk's deck.

Test keys: refused with 403 TEST_KEY_NOT_ALLOWED. The Switch has no test mode, so a change always applies to your live configuration. Test keys can still read Switch data.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`markupPct`required	number	-min -100
`prefixes`	string[]	Only these prefixes; omit for the whole deck

Response 200

Field	Type	Description
`data`required	object	-
`updated`requireddata.updated	integer	-
`skipped`requireddata.skipped	integer	-
`basis`data.basis	any	-
`revisionId`requireddata.revisionId	string (uuid) \| null	-

Response 202

Field	Type	Description
`data`required	object	-
`approvalRequired`data.approvalRequired	boolean	-One of `true`
`approvalRequestId`data.approvalRequestId	string (uuid) \| null	-
`permission`data.permission	string	-
`expiresAt`data.expiresAt	string (date-time)	-
`message`data.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.
AlsoSTALE_WRITE

HTTP

curl -X POST "https://packetexchange.io/api/v1/switch/customer-trunks/<trunkId>/rates/apply-markup" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "markupPct": 1
}'

Run it here with a test key.

Export a trunk's sell rates as CSV

GET/api/v1/switch/customer-trunks/{trunkId}/rates.csv

Access: API key. Scoped keys need switch:manage.
Rate limit: 100 requests per second (the default)

Scoped to this trunk's deck; takes the same filters as the list.

Parameters

Name	In	Type	Description
`trunkId`required	path	string (uuid)	-
`search`	query	string	Prefix or destination text
`view`	query	string	Default currentOne of current, scheduled, discontinued, expiring, all
`origin`	query	string	-One of any, origin_only, destination_only
`increment`	query	string	-One of any, custom, inherited
`cost`	query	string	-One of any, missing
`margin`	query	string	-One of any, thin, negative

Response 200 (text/csv)

The trunk's filtered sell deck as a CSV attachment.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
402SWITCH_SUBSCRIPTION_REQUIRED: the account has no active Switch plan or trial.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.