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

Request message for the ArchiveAgentLeavePetition.

agent_leave_petition_id

integer <int64> | string

agent_leave_petition_id

optional

ID of the agent leave petition to archive.

Example

{
  "agent_leave_petition_id": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the ArchiveAgentLeavePetition.

agent_leave_petition

object (AgentLeavePetition)

agent_leave_petition

optional

The archived Agent Leave Petition.

petition_status

enum<string>

petition_status

optional

Current status of the time off request.

Allowed values:

UNSPECIFIED_PETITION_STATUSPENDING_PETITIONAPPROVED_PETITIONDENIED_PETITIONCANCELLED_PETITION

created_time

string <date-time>

created_time

optional

The timestamp from when the request was created.

Examples:

1s1.000340012s

archived_time

string <date-time>

archived_time

optional

The timestamp from when the timestamp was archived, if it has been archived.
This field is null by default.

Examples:

1s1.000340012s

resolved_time

string <date-time>

resolved_time

optional

The timestamp from when the timestamp was resolved, if it has been resolved.
The request is resolved when it is either approved or denied.
This field is null by default.

Examples:

1s1.000340012s

petition_comment

string

petition_comment

optional

A comment sent by agent when the time off was requested.

response_comment

string

response_comment

optional

A response from the manager when the request was approved or denied.
This field is null by default.

requested_datetime_ranges

array[object (DatetimeRange) {2}]

requested_datetime_ranges

optional

A list of datetime ranges to be blocked off on the schedule.

resolved_by_user_id

string

resolved_by_user_id

optional

The user ID of the manager who approved or denied the request.
This field is null by default.

requested_hours_off

number <float>

requested_hours_off

optional

The number of working hours requested off.
This 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.

agent_leave_petition_id

integer <int64> | string

agent_leave_petition_id

optional

ID of the agent leave petition.

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

ID of the agent requesting the time off.

Example

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

🔴500Server Error