Create a threshold alert rule

POST

/v1/workspace/contact-center/alert-rules

curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/alert-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "service_level", "queue_id": "example", "threshold": 1, "window": "today", "reason_code": "example", "cooldown_seconds": 600, "team_id": "example", "duration_minutes": 1, "subscriber_user_ids": [ "example" ] }'

Authorizations

• HTTPBearer

Parameters

Header Parameters

Idempotency-Key

Any of:

string

string

null

null

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Body^required

Media typeapplication/json

CcAlertRuleCreate

object

kind

required

Kind

string

Allowed values: service_level longest_wait calls_waiting available_agents abandon_rate agent_state_duration adherence

queue_id

Any of:

string

string

>= 1 characters <= 96 characters /^[A-Za-z0-9_:-]+$/

null

null

threshold

required

Threshold

number

<= 86400

window

Window

string

default: today

Allowed values: today last_15m

reason_code

Any of:

string

string

<= 40 characters

null

null

cooldown_seconds

Cooldown Seconds

integer

default: 600 >= 60 <= 86400

team_id

Any of:

string

string

>= 1 characters <= 96 characters /^[A-Za-z0-9_:-]+$/

null

null

duration_minutes

Any of:

integer

integer

>= 1 <= 120

null

null

subscriber_user_ids

Subscriber User Ids

Array<string>

<= 200 items

Responses

201

Successful Response

Media typeapplication/json

CcAlertRule

object

id

required

Id

string

revision

required

Revision

integer

kind

required

Kind

string

Allowed values: service_level longest_wait calls_waiting available_agents abandon_rate agent_state_duration adherence

queue_id

required

Any of:

string

string

null

null

queue_name

required

Any of:

string

string

null

null

threshold

required

Threshold

number

window

required

Window

string

Allowed values: today last_15m

reason_code

required

Any of:

string

string

null

null

cooldown_seconds

required

Cooldown Seconds

integer

team_id

Any of:

string

string

null

null

team_name

Any of:

string

string

null

null

duration_minutes

Any of:

integer

integer

null

null

enabled

required

Enabled

boolean

is_default

required

Is Default

boolean

description

required

Description

string

subscribed

required

Subscribed

boolean

muted

required

Muted

boolean

subscriber_count

required

Subscriber Count

integer

can_edit

required

Can Edit

boolean

created_at

required

Created At

string format: date-time

Example

{
  "kind": "service_level",
  "window": "today"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}