--- title: "Update a phone number" method: PATCH path: "/v1/numbers/{id}" tags: ["My numbers"] --- # Update a phone number `PATCH /v1/numbers/{id}` Updates the phone number identified by `id`. Only the provided fields are changed. ## Path parameters - `id` integer, required ## Request body - NumberUpdateRequest — Fields to update on a phone number. All fields are optional; only the provided fields are changed. - `sms_enabled` boolean — Indicates whether SMS is enabled for the phone number. - `destinations` NumberDestination[] — Inbound call routing destinations for the phone number. - `destination` string, required — SIP URI, PSTN number, or SIP trunk login for inbound call routing. - `priority` integer, required — Destination priority (lower is higher priority). - `transport` 1 | 4 | 5, required — Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform). - `trunk_id` integer, nullable — SIP trunk ID when `transport` is 5, otherwise null. - `sms_relay_url` string, uri — Callback URL for inbound messages. - `call_recording_enabled` boolean — Indicates whether call recording is enabled. - `transcription_enabled` boolean — Indicates whether call transcription is enabled. - `transcription_threshold` integer — Minimum call duration in seconds before transcription runs. - `call_status_url` string, uri — Callback URL for call status updates. ## Response `200` Returns the updated phone number. - Number - `id` integer, required — Phone number ID. - `number` string, required — Phone number. - `activation_fee` string, required — One-time activation fee in USD. - `monthly_fee` string, required — Monthly fee in USD. - `per_min` string, required — Price per inbound minute in USD. - `city` string, required — City or rate center where the phone number originates. - `state` string, nullable — State where the phone number originates. For non-US numbers, this field may be null. - `country` string, required — Country where the phone number originates. - `country_short_name` string, required — Two-letter ISO country code. - `destination` InboundCallDestination[], required — Inbound call destinations set for the phone number. - `id` integer, required — Unique identifier of the inbound call destination - `destination` string, required — The destination for inbound call routing. Can be either a SIP URI, a PSTN phone number or system-generated login of a SIP trunk on the platform. - `priority` integer, required — For phone numbers with several destinations, sets the order in which the platform routes inbound calls. The lower the value, the higher the priority. - `transport` 1 | 4 | 5, required — Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform). - `trunk_id` integer, nullable, required — Unique identified of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null` - `srtp` boolean — Indicates whether SRTP media encryption is enabled for this destination. - `trunk_label` string, nullable, required — A user-defined name of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null` - `channels` integer, required — Maximum number of concurrent inbound calls. - `require_docs` string[], required — Documents required to activate the phone number. - `documents` NumberDocument[], required — Uploaded documents for the phone number. - `id` integer, required — Unique identifier of the uploaded document - `allow_replace` boolean, required — Indicates whether the document can be replaced. Only documents with `rejected` status can be replaced. - `did_number` string, required — The phone number the document was uploaded for - `doc_content_type` string, required — The uploaded content type identified by the platform - `doc_file_name` string, required — The uploaded document name - `doc_type_id` 1 | 2 | 3, required — Specifies the type of document required to activate the phone number. Possible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration. - `status` string, required — Status of the uploaded document. Can be either `approved`, `pending`, or `rejected` - `url` string, required — A link to the uploaded document - `domestic_cli` boolean, required — Indicates whether the number can be used as the Caller ID for local calls. - `free_min` integer — Number of free inbound minutes. - `unlimited` boolean — Indicates whether usage is unlimited. - `label` string, nullable, required — Label assigned to the phone number. - `status` string, required — Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot. - `seconds` string, required — Total inbound call duration in seconds for current month. - `added` string, date-time, required — Date and time the phone number was purchased in ISO 8601 format. - `paid_until` string, date, required — Date until which the number is paid. - `sms_enabled` boolean, required — Indicates whether SMS is enabled. - `sms_relay_url` string, nullable, required — Callback URL for inbound SMS and MMS messages. - `cnam` boolean, nullable, required — Indicates whether CNAM is enabled. - `call_recording_enabled` boolean, required — Indicates whether call recording is enabled. - `transcription_enabled` boolean, required — Indicates whether transcription is enabled. - `transcription_threshold` integer, required — Minimum call duration in seconds to trigger transcription. - `call_status_url` string, nullable — Callback URL for call status updates. ## Other responses - `400` — Request failed. Missing or invalid parameter - `403` — Request failed. The feature is disabled for your account. - `404` — Request failed. An object with the specified ID is not found. --- [API](https://skmtc.net/wavix/apis/wavix-apis.md) · [All operations](https://skmtc.net/wavix/apis/wavix-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wavix/wavix-apis/versions/b22f170488b6/schema)