post https://api.talkdeskapp.com/wfm/aion/externals/schedules/time-offs
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. >= 1 characters <= 255 characters Example: [email protected] | no |
| description | string | Description or comment associated with the time-off. >= 0 characters <= 255 characters Example: Take some rest | no |
| end_at | string | End date and time for time off in UTC. >= 20 characters <= 20 characters Example: 2019-06-22T01:29:31.000Z | 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. >= 1 characters <= 255 characters Example: Medical leave | yes |
| id | string | The ID of the time off. >= 1 characters <= 255 characters Example: 92af91d0-759b-11e9-89d9-833f7653c849 | yes |
| start_at | string | Start date and time for time off in UTC. >= 20 characters <= 20 characters Example: 2019-06-22T01:14:31.000Z | 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) |
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.