Update a number

patch

https://api.emaktalk.com/api/v1/numbers/{phoneNumberId}

Updates a phone number's routing and settings; fields you omit keep their current values. Routing changes regenerate and reload the number's routing, and sending destination_actions at all — even with values identical to the current ones — claims manual routing ownership and detaches the number from the call flow it belonged to. domain_uuid, provider_uuid, provider_verified, destination_enabled and domain_name are ignored without an error. If a step after the write fails, a rollback is attempted and the response says whether it succeeded. Every change is recorded in the number's history. Changing the number, its prefix or its match pattern is an identity change: if the result would point at a phone number another account already routes, the request is refused with 403 and nothing is saved. Submitting those fields with the values they already hold is not an identity change and saves normally.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

phoneNumberId

string

required

ID of the phone number to update. The format is not checked before the lookup.

Body Params

destination_actions

array of objects

Routing actions for the number. The first entry supplies the flat app and data, and the array is stored when both are present. Sending a non-null array detaches the number from any call flow.

destination_actions

fax_meta_properties

string

Fax metadata, stored as sent.

destination_type_text

number

Whether the number carries text messaging.

destination_type_emergency

number

Whether the number is usable for emergency calling.

destination_order

number

Sort order for the number.

destination_type

string

Type of the destination.

destination_number

string

The phone number itself.

destination_prefix

string

Prefix stored with the number.

destination_number_regex

string

Match expression used to recognize the number on an inbound call.

destination_caller_id_name

string

Caller ID name sent with calls on this number. Trimmed.

destination_caller_id_number

string

Caller ID number sent with calls on this number.

destination_cid_name_prefix

string

Prefix added to the caller ID name. Trimmed.

destination_context

string

Routing context the number belongs to.

destination_app

string

Routing application for the number. Overrides the value derived from destination_actions.

destination_data

string

Argument for the routing application. Overrides the value derived from destination_actions.

destination_description

string

Free-text description of the number. Trimmed.

destination_record

boolean

Whether calls on this number are recorded. Stored as the string true or false.

destination_alternate_app

string

Alternate routing application.

destination_alternate_data

string

Argument for the alternate routing application.

destination_hold_music

string

Hold music used for calls on this number.

destination_uuid

string

The number's own ID. It can be changed here, so send it only when you mean to.

dialplan_uuid

string

ID of the routing entry associated with this number.

fax_uuid

string

Fax account this number delivers to. Send an empty string to clear it.

user_uuid

string

User this number is assigned to. Send an empty string to clear it.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The number was updated. The response also reports any call flow detachment.

400The number has no routing entry to update, or the write failed.

403The requested routing points at a phone number another account routes.

404No such number, either before or after the update.

422The routing could not be regenerated because the number, its match expression or its account details are incomplete.

502A lookup, routing regeneration or cache reload failed. A rollback was attempted and the response says whether it succeeded.