Skip to content
vocapable.Docs

Excuse an adherence exception

POST
/v1/workspace/contact-center/wfm/adherence/excusals
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/wfm/adherence/excusals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_id": "example", "starts_at": "2026-04-15T12:00:00Z", "ends_at": "2026-04-15T12:00:00Z", "note": "example" }'

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
CcWfmExcusalCreate
object
user_id
required
User Id
string
>= 1 characters <= 96 characters /^[A-Za-z0-9_:-]+$/
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
note
Any of:
string
<= 280 characters
Examplegenerated
{
  "user_id": "example",
  "starts_at": "2026-04-15T12:00:00Z",
  "ends_at": "2026-04-15T12:00:00Z",
  "note": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
CcWfmExcusal
object
id
required
Id
string
user_id
required
User Id
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
note
required
Any of:
string
created_at
required
Created At
string format: date-time
Examplegenerated
{
  "id": "example",
  "user_id": "example",
  "starts_at": "2026-04-15T12:00:00Z",
  "ends_at": "2026-04-15T12:00:00Z",
  "note": "example",
  "created_at": "2026-04-15T12:00:00Z"
}

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