POST /api/v2/offices/{id}/operators

Adds an operator into office's mainline.

Added on Sep 22, 2023 for API v2.

Rate limit: 1200 per minute.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The office's ID.

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

Type of the operator to add. (user or room)

Possible values:

  • "room"
  • "user"
operator_id Integer Yes

ID of the operator to add.

role String No

The role of the new operator. (operator or admin)

Possible values:

  • "operator"
  • "admin"

Default value: "operator"

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.