POST /api/v2/users/{id}/unassign_number

Un-assigns a phone number from a user. The number will be returned to the company's reserved block if there is one. Otherwise the number will be released.

Added on May 3, 2018 for API v2.

Rate limit: 1200 per minute.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The user's id. ('me' can be used if you are using a user level API key)

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
number String Yes

A phone number to unassign. (e164-formatted)

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.