Holiday

Delete a holiday

Changed on
delete/v1/workspaces/{workspaceId}/holidays/{holidayId}

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/holidays/{holidayId}
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8
holidayIdstring required

Represents a holiday identifier across the system.

Example:60f927920658241e3cf35e02

Response

OK

colorstring

Provide color in format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

countryNamestring

Represents imported public holiday country name.

everyoneIncludingNewboolean

Indicates whether the holiday is shown to new users.

idstring

Represents holiday identifier across the system.

importedboolean
namestring

Represents the name of the holiday.

occursAnnuallyboolean

Indicates whether the holiday occurs annually.

userGroupIdsstring[]

Indicates which user groups are included.

userIdsstring[]

Indicates which users are included.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "color": "#8BC34A",
  "id": "5b715612b079875110791111",
  "name": "New Year's Day",
  "occursAnnually": true,
  "userGroupIds": [
    "5b715612b079875110791342",
    "5b715612b079875110791324",
    "5b715612b079875110793142"
  ],
  "userIds": [
    "5b715612b079875110791432",
    "5b715612b079875110791234"
  ],
  "workspaceId": "5b715612b079875110792222"
}

Changes

  • a5b636acbcd8Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status