ArchiveAgentLeavePetition

POST

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

Archives an agent leave petition with the given @agent_leave_petition_id for the org sending the request.
If the leave petition has the status of PENDING_PETITION, the petition must be resolved first, or the request will error.
If the petition has a status of APPROVED_PETITION and a portion of the petitions @requested_datetime_ranges lies in the future,
the petition may not be archived without being cancelled.
Errors:

grpc.Invalid: the request data is invalid, the agent leave petition is approved for a future datetime, still pending, or is already archived.

grpc.Internal: error occurs when archiving the agent leave petition.

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

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/archiveagentleavepetition' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

ListAgentLeavePetitions

ResolveAgentLeavePetition