Holidays

Action a Holiday

Update a holiday. You can use this to :

  1. Approve a pending holiday
  2. Decline a pending holiday
  3. Cancel a holiday

<strong>Note:</strong> This will raise a Webhook event if you have Webhooks configured.

<strong>Important:</strong> an action that is refused still returns <strong>200</strong>. Check approvalResult in the response body rather than relying on the status code. Its values are:

  • Success — the action was applied.
  • AlreadyActioned — the holiday has already been approved, declined or cancelled.
  • DoesntExist — the holiday could not be found when the action was applied.
  • NotAllowed — you are not allowed to perform that action on this holiday.
  • UnknownError — the action failed, or no recognised holidayUpdateAction was supplied.

message carries a human readable version of the same thing.

post/api/holidays/{id}

Request

  • Base URL: https://app.timetastic.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://app.timetastic.co.uk/api/holidays/{id}
  • Auth: none declared

Path parameters

idstring required

The id of the holiday / a holiday token

Query parameters

holidayUpdateAction'Approve' | 'Decline' | 'Delete' | 'DeleteGroup'
  • Approve
  • Decline
  • Delete
  • DeleteGroup

The action you want to perform to the holiday

Request body

reasonstring nullable

An optional reason for rejecting a leave request.

suppressEmailsboolean

Set to true to suppress notifications and emails to users when actioning holiday requests.

Response

The request was processed. Check approvalResult in the body — this is also returned when the action was refused.

approvalResult'Success' | 'AlreadyActioned' | 'DoesntExist' | 'UnknownError' | 'NotAllowed'
  • Success
  • AlreadyActioned
  • DoesntExist
  • UnknownError
  • NotAllowed
messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.