Skip to content
vocapable.Docs

Create a shift template

POST
/v1/workspace/contact-center/wfm/shift-templates
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/wfm/shift-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "start_time": "example", "duration_minutes": 1, "weekdays": [ 1 ], "activities": [] }'

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
CcWfmShiftTemplateCreate
object
name
required
Name
string
>= 1 characters <= 80 characters
start_time
required
Start Time
string
/^([01][0-9]|2[0-3]):(00|15|30|45)$/
duration_minutes
required
Duration Minutes
integer
>= 30 <= 960
weekdays
required
Weekdays
Array<integer>
>= 1 items <= 7 items
activities
Activities
Array<object>
default: <= 12 items
CcWfmTemplateActivity
object
kind
required
Kind
string
Allowed values: break lunch meeting training coaching custom time_off
offset_minutes
required
Offset Minutes
integer
<= 960
duration_minutes
required
Duration Minutes
integer
>= 15 <= 960
reason_code
Any of:
string
>= 1 characters <= 96 characters /^[A-Za-z0-9_:-]+$/

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
CcWfmShiftTemplate
object
id
required
Id
string
revision
required
Revision
integer
name
required
Name
string
start_time
required
Start Time
string
duration_minutes
required
Duration Minutes
integer
weekdays
required
Weekdays
Array<integer>
activities
required
Activities
Array<object>
CcWfmTemplateActivity
object
kind
required
Kind
string
Allowed values: break lunch meeting training coaching custom time_off
offset_minutes
required
Offset Minutes
integer
<= 960
duration_minutes
required
Duration Minutes
integer
>= 15 <= 960
reason_code
Any of:
string
>= 1 characters <= 96 characters /^[A-Za-z0-9_:-]+$/
archived
required
Archived
boolean
created_at
required
Created At
string format: date-time
Example
{
  "activities": [
    {
      "kind": "break"
    }
  ]
}

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": {}
    }
  ]
}