Skip to content
vocapable.Docs

Change planning defaults (shrinkage, grace, history)

PUT
/v1/workspace/contact-center/wfm/settings
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/contact-center/wfm/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "shrinkage": 1, "max_occupancy": 1, "grace_minutes": 1, "history_weeks": 1, "recency_decay": 1, "max_shifts_per_week": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CcWfmSettingsUpdate
object
expected_revision
required
Expected Revision
integer
>= 1
shrinkage
Any of:
number
<= 0.8
max_occupancy
Any of:
number
>= 0.5 <= 1
grace_minutes
Any of:
integer
<= 15
history_weeks
Any of:
integer
>= 4 <= 26
recency_decay
Any of:
number
>= 0.3 <= 1
max_shifts_per_week
Any of:
integer
>= 1 <= 7
Examplegenerated
{
  "expected_revision": 1,
  "shrinkage": 1,
  "max_occupancy": 1,
  "grace_minutes": 1,
  "history_weeks": 1,
  "recency_decay": 1,
  "max_shifts_per_week": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmSettings
object
revision
required
Revision
integer
shrinkage
required
Shrinkage
number
max_occupancy
required
Max Occupancy
number
grace_minutes
required
Grace Minutes
integer
history_weeks
required
History Weeks
integer
recency_decay
required
Recency Decay
number
max_shifts_per_week
required
Max Shifts Per Week
integer
timezone
required
Timezone
string
Examplegenerated
{
  "revision": 1,
  "shrinkage": 1,
  "max_occupancy": 1,
  "grace_minutes": 1,
  "history_weeks": 1,
  "recency_decay": 1,
  "max_shifts_per_week": 1,
  "timezone": "example"
}

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