POST /api/v2/users

Creates a new user.

Added on March 22, 2018 for API v2.

Rate limit: 1200 per minute.

Servers

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
email String Yes

The user's email.

last_name String No

[single-line only]

The user's last name.

license String No

The user's license type. This affects billing for the user.

Possible values:

  • "dpde_all"
  • "lite_lines"
  • "lite_support_agents"
  • "talk"
  • "admins"
  • "agents"
  • "dpde_one"
  • "magenta_lines"

Default value: "talk"

first_name String No

[single-line only]

The user's first name.

auto_assign Boolean No

If set to true, a number will be automatically assigned.

Default value: false

office_id Integer Yes

The user's office 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.