PATCH /api/v2/dispositions/{id}

Updates the disposition by id. Bulk updates for the targets assigned to a disposition is not supported.

Added on April 4, 2024 for API v2.

Rate limit: 1200 per minute.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The id of the dispositions.

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
dispositions Null No

The dispositions.

name Null No

[single-line only]

The name of the parent disposition.

action Null No

The action will determine whether to add or remove the specified target from the dispositions.

Valid values:

  • "remove_target"
  • "add_target"
target_id Integer No

The target id for the dispositions.

target_type Null No

The target type for the dispositions.

Valid values:

  • "coachingteam"
  • "callcenter"
  • "unknown"
  • "coachinggroup"

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.