close anchor

Phones

To get information on phone numbers:

GET /phones

Parameters

Param Type Description Optional
id string The UUID of an individual phone number.
user string The UUID of the primary user identified with a phone number, being the user who initially entered it to the project, if known. Include an empty value to query for phones identified with no primary user.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: country, date_time.edit, date_time.init, id.
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the phone object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of phone(s).

To post a phone number:

POST /phones

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
name string The name of this phone number, provided in the endpoint transaction locale.
country string The ISO 3166-1 alpha-2 code of the country to be identified with the phone number. If provided, the number is validated based on this location, too.
number string The phone number, being the equivalent of a phone object's number::text property. In general, this will be the literal value entered by the user. This enables users to indicate a preferred format, if desired.
extension string The internal or local extension identified with the phone number.

The data object provided by this endpoint is the phone number entity inserted to the project.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_country The country provided is not a valid ISO 3166-1 alpha-2 code.
invalid_phone_number The phone number entered is not valid.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update a phone number:

PUT /phones

In order to edit a phone number, log in the user identified with the phone number (or a user with editor-level privileges).

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The UUID of the phone number to be updated.
name string The name of this phone number, provided in the endpoint transaction locale.
country string The ISO 3166-1 alpha-2 code of the country to be identified with the phone number. If provided, the number is validated based on this location, too.
number string The phone number, being the equivalent of a phone object's number::text property. In general, this will be the literal value entered by the user. This enables users to indicate a preferred format, if desired.
extension string The internal or local extension identified with the phone number.

The data object provided by this endpoint is the updated phone number entity.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_country The country provided is not a valid ISO 3166-1 alpha-2 code.
invalid_phone_number The phone number entered is not valid.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a phone number:

DELETE /phones

In order to delete a phone number, log in the user identified with the phone number (or a user with editor-level privileges).

Parameters

Param Type Description
id string The UUID of the phone number to be deleted.

The data object provided by this endpoint is the deleted phone number.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*