PATCH /api/v2/dispositions/{id}

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

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

A dict mapping disposition names to their config. Each value has three optional tilde-prefixed control attributes: ~usage: "everything" (default) | "inbound" | "outbound" — call direction restriction. ~followup: bool — whether this disposition requires a follow-up action. ~default: bool — whether this is the default selection. Any other key in the value dict is a sub-disposition name with the same structure. Example: { "resolved": {"~usage": "everything"}, "callback": {"~usage": "inbound", "~followup": true}, "escalate": { "~usage": "outbound", "tier2": {"~usage": "outbound"}, "manager": {}, }, }

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:

  • null
  • "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:

  • null
  • "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.