Created via an external service, returning the newly created time off item
Scope
wfm-aion-public:write
Body Request - Example
{
"agent_email": "[email protected]",
"description": "Take some rest",
"end_at": "2019-06-22T01:29:31Z",
"event_type_name": "Medical leave.",
"start_at": "2019-06-22T01:14:31Z"
}Body Response - Schema
201 (the payload was accepted by the server and stored in the database successfully)
| Parameter | Type | Description | Required |
|---|---|---|---|
| agent_email | string | Email of the agent that will be on time off.
| no |
| description | string | Description or comment associated with the time-off.
| no |
| end_at | string<date-time> | End date and time for time off in UTC.
| yes |
| event_type_name | string | Name of the event type that will be associated with the time off. The event type with that name must be previously created in WFM and must be of type TIME OFF.
| yes |
| id | string | The ID of the time off.
| yes |
| start_at | string<date-time> | Start date and time for time off in UTC.
| yes |
400 (validation errors were found in the submitted data), 401 (unauthorized), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| description | string | n/a | yes |
| message | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
TroubleshootingIf 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.