CreateAgentLeavePetition

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/createagentleavepetition

Creates an agent leave petition to request time off for the @wfm_agent_sid over the @requested_datetime_ranges for the org sending the request.
The @petition_comment must be set with a value.
The @requested_datetime_ranges may not overlap each other.
The number of working hours requested off should be set in @requested_hours_off.
The @requested_hours_off does not need to relate directly to the datetime range being requested off,
for example in the case where a 14 hour schedulable range is being taken off but 8 hours of work will be paid out with PTO.
The usage of @requested_hours_off hours will depend on org policy, but is not yet implemented.
Errors:

grpc.Invalid: the request data is invalid.

grpc.Internal: error occurs when creating the time off request.

grpc.NotFound: the @wfm_agent_sid does not exist for the org sending the request.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "requested_datetime_ranges": [
        {
            "start_datetime": "1s",
            "end_datetime": "1s"
        }
    ],
    "petition_comment": "string",
    "wfm_agent_sid": 0,
    "requested_hours_off": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/createagentleavepetition' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requested_datetime_ranges": [
        {
            "start_datetime": "1s",
            "end_datetime": "1s"
        }
    ],
    "petition_comment": "string",
    "wfm_agent_sid": 0,
    "requested_hours_off": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "agent_leave_petition": {
        "agent_leave_petition_id": 0,
        "wfm_agent_sid": 0,
        "petition_status": "UNSPECIFIED_PETITION_STATUS",
        "petition_comment": "string",
        "response_comment": "string",
        "requested_datetime_ranges": [
            {
                "start_datetime": "1s",
                "end_datetime": "1s"
            }
        ],
        "created_time": "1s",
        "archived_time": "1s",
        "resolved_time": "1s",
        "resolved_by_user_id": "string",
        "requested_hours_off": 0
    }
}

🟢200Success

Modified at 2025-09-26 15:44:58

CopyShiftsToPublishedSchedule

ListAgentLeavePetitions