Balance Assignment

Creates a new balance assignment for a user in policy

Changed on
post/v1/workspaces/{workspaceId}/time-off/balance/assignment

Request

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

Path parameters

workspaceIdstring required

Represents workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8

Request body

balancenumber double required

Represents the amount of balance to be created

notestring

Represents note attached to updating balance.

policyIdstring required

Represents the identifier of the policy where the balance assignment will be created

userIdsstring[] required

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

Example request

{
  "balance": 12,
  "dateRange": {
    "end": "2021-12-25",
    "start": "2021-12-23"
  },
  "note": "Bonus days added.",
  "policyId": "63034cd0cb0fb876a57e93ad",
  "userIds": [
    "5b715448b079875110792222",
    "5b715448b079875110791111"
  ]
}

Response

Created

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

    • info

      the request property default value was added