Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Holiday

Update a holiday

put/v1/workspaces/{workspaceId}/holidays/{holidayId}

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8

Represents a workspace identifier across the system.

holidayIdstring required

Represents a holiday identifier across the system.

Example:60f927920658241e3cf35e02

Represents a holiday identifier across the system.

Request body

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.

everyoneIncludingNewboolean

Indicates whether the holiday is shown to new users.

namestring required

Provide the name you would like to use for updating the holiday.

occursAnnuallyboolean required

Indicates whether the holiday occurs annually.

Example request

{
  "color": "#8BC34A",
  "datePeriod": {
    "endDate": "2023-02-16",
    "startDate": "2023-02-14"
  },
  "name": "New Year's Day",
  "occursAnnually": true,
  "userGroups": {
    "contains": "CONTAINS",
    "ids": [
      "5a0ab5acb07987125438b60f",
      "64c777ddd3fcab07cfbb210c"
    ],
    "status": "ACTIVE"
  },
  "users": {
    "contains": "CONTAINS",
    "ids": [
      "5a0ab5acb07987125438b60f",
      "64c777ddd3fcab07cfbb210c"
    ],
    "status": "ACTIVE"
  }
}

Response

OK

automaticTimeEntryCreationboolean

Indicates that time entries will be automatically created for this holiday.

everyoneIncludingNewboolean

Indicates whether the holiday is shown to new users.

idstring

Represents holiday identifier across the system.

namestring

Represents the name of the holiday.

occursAnnuallyboolean

Indicates whether the holiday occurs annually.

projectIdstring

Represents projectId for automatic time entry creation.

taskIdstring

Represents taskId for automatic time entry creation.

userGroupIdsstring[]

Indicates which user groups are included.

userIdsstring[]

Indicates which users are included.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "id": "5b715612b079875110791111",
  "name": "New Year's Day",
  "occursAnnually": true,
  "projectId": "65b36d3c525e243c48f9150f",
  "taskId": "65b36d46fa3df8607e42d21a",
  "userGroupIds": [
    "5b715612b079875110791342",
    "5b715612b079875110791324",
    "5b715612b079875110793142"
  ],
  "userIds": [
    "5b715612b079875110791432",
    "5b715612b079875110791234"
  ],
  "workspaceId": "5b715612b079875110792222"
}