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

Set Caller ID for a determined User id.

Added on Aug 3, 2022 for API v2.

Rate limit: 1200 per minute.

Servers

Path parameters

Name Type Required Description
id String 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
caller_id String Yes

Phone number (e164 formatted) that will be defined as a Caller ID for the target. Use 'blocked' to block the Caller ID.

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.