Skip to content
vocapable.Docs

Save a wallboard view (queues, teams, tiles, thresholds, rotation)

POST
/v1/workspace/contact-center/wallboard-views
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/wallboard-views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "shared": false, "queue_ids": [ "example" ], "team_ids": [ "example" ], "tiles": [ "out_of_adherence" ], "thresholds": { "additionalProperty": { "additionalProperty": 1 } }, "rotate_seconds": 1, "channel": "voice" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

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 Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CcWallboardViewSettings
object
name
required
Name
string
>= 1 characters <= 80 characters
shared
Shared
boolean
queue_ids
Queue Ids
Array<string>
<= 50 items
team_ids
Team Ids
Array<string>
<= 50 items
tiles
Tiles
Array<string>
<= 12 items
Allowed values: out_of_adherence waiting longest_wait service_level service_level_interval asa aht abandon_rate answered offered agents_by_state ewt callbacks
thresholds
Thresholds
object
key
additional properties
object
key
additional properties
number
rotate_seconds
Any of:
integer
>= 15 <= 120
channel
Channel
string
default: all
Allowed values: voice sms all

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
CcWallboardView
object
name
required
Name
string
>= 1 characters <= 80 characters
shared
Shared
boolean
queue_ids
Queue Ids
Array<string>
<= 50 items
team_ids
Team Ids
Array<string>
<= 50 items
tiles
Tiles
Array<string>
<= 12 items
Allowed values: out_of_adherence waiting longest_wait service_level service_level_interval asa aht abandon_rate answered offered agents_by_state ewt callbacks
thresholds
Thresholds
object
key
additional properties
object
key
additional properties
number
rotate_seconds
Any of:
integer
>= 15 <= 120
channel
Channel
string
default: all
Allowed values: voice sms all
id
required
Id
string
revision
required
Revision
integer
owner_user_id
required
Any of:
string
can_edit
required
Can Edit
boolean
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "shared": false,
  "tiles": [
    "out_of_adherence"
  ],
  "channel": "voice"
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}