Balance

Update a balance

Changed on
patch/v1/workspaces/{workspaceId}/time-off/balance/policy/{policyId}

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/time-off/balance/policy/{policyId}
  • 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
policyIdstring required

Represents a policy identifier across the system.

Example:63034cd0cb0fb876a57e93ad

Request body

notestring

Represents a new balance note value.

syncboolean

Indicates whether the call should be executed synchronously. By default, call is done asynchronously

userIdsstring[] required

Represents the list of users' identifiers whose balance is to be updated.

valuenumber double required

Represents the change in balance value.

Example request

{
  "dateRange": {
    "end": "2021-12-25",
    "start": "2021-12-23"
  },
  "note": "Bonus days added.",
  "sync": true,
  "userIds": [
    "5b715448b079875110792222",
    "5b715448b079875110791111"
  ],
  "value": 22
}

Response

No Content

Changes

  • a5b636acbcd8Revision changes
    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added