Importing Time-Off Balance

Scope

wfm-request-management-public:write

Response Example

{
  "time_off_balances": [
    {
      "id": "8858c834481d4a028176cffc02c50350",
      "agent_email": "[email protected]",
      "event_type_name": "annual",
      "balance": 1200
    },
    {
      "id": "028176cffc034481d4ac5035028858c8",
      "agent_email": "[email protected]",
      "event_type_name": "break",
      "balance": 200
    }
  ]
}

Body Response

200 OK - Time Off balance successfully updated.

Parameter Type Description

time_off_balances

array[object]

Parameter	Type	Description
time_off_balances	array[object]	The time off balance. "time_off_balances" subdivides into: "id" (string) - The ID of the time off balance. Example: `<= 36 characters` "agent_email" (string) - The email of the user. "event_type_name" (string) - Defines part of the time off type. "balance" (number) - The balance of the time off type. `> = 1` `<= 50000`

The time off balance.
"time_off_balances" subdivides into:

- "id" (string) - The ID of the time off balance.
  Example: <= 36 characters
- "agent_email" (string) - The email of the user.
- "event_type_name" (string) - Defines part of the time off type.
"balance" (number) - The balance of the time off type.
> = 1
<= 50000

400 (validation errors found), 401 (unauthorized), 403 (forbidden), 404 (not found)

Parameter	Type	Description	Required
code	string	n/a	yes
message	string	n/a	yes
description	string	n/a	no
fields	array[object]	"fields" subdivides into: "name" (string) "description" (string)	yes (name and description)

🚧
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.