v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Time Off

Create time off

Create a time off for a teammate.

Required scope: time_off:write

post/teammates/{teammate_id}/time_offs

Path parameters

teammate_idstring required

The teammate ID. Alternatively, you can supply an email as a resource alias.

Request body

namestring required

Name of the time off

start_atnumber required

Timestamp when the time off starts (in seconds)

end_atnumber nullable

Timestamp when the time off ends (in seconds), or null if open-ended

Response

A time off

idstring required

Unique identifier of the time off

namestring required

Name of the time off

start_atnumber required

Timestamp when the time off starts

end_atnumber nullable

Timestamp when the time off ends, or null if open-ended

created_atnumber

Timestamp when the time off was created

updated_atnumber

Timestamp when the time off was last updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/time_offs/vcr_1bri",
    "related": {
      "teammate": "https://yourCompany.api.frontapp.com/teammates/tea_1bri"
    }
  },
  "id": "vcr_1bri",
  "name": "Out of office",
  "start_at": 1606943265.298,
  "end_at": 1607548065.298,
  "created_at": 1606943265.298,
  "updated_at": 1606943265.298,
  "auto_responder": {
    "is_enabled": true,
    "channel_ids": [
      "cha_1bri",
      "cha_2bri"
    ],
    "body": "Thanks for reaching out, I will reply when I am back."
  }
}