Scheduling

Publish assignments

Changed on
put/v1/workspaces/{workspaceId}/scheduling/assignments/publish

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/scheduling/assignments/publish
  • 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:64a687e29ae1f428e7ebe303

Request body

endstring required

Represents end date in yyyy-MM-ddThh:mm:ssZ format.

notifyUsersboolean

Indicates whether to notify users when assignment is published.

searchstring

Represents a search string.

startstring required

Represents start date in yyyy-MM-ddThh:mm:ssZ format.

viewType'PROJECTS' | 'TEAM' | 'ALL'

Represents view type.

Example request

{
  "end": "2021-01-01T00:00:00Z",
  "search": "search keyword",
  "start": "2020-01-01T00:00:00Z",
  "userFilter": {
    "contains": "CONTAINS",
    "ids": [
      "5a0ab5acb07987125438b60f",
      "64c777ddd3fcab07cfbb210c"
    ],
    "sourceType": "USER_GROUP",
    "status": "ACTIVE",
    "statuses": [
      "PENDING",
      "INACTIVE"
    ]
  },
  "userGroupFilter": {
    "contains": "CONTAINS",
    "ids": [
      "5a0ab5acb07987125438b60f",
      "64c777ddd3fcab07cfbb210c"
    ],
    "status": "ACTIVE"
  },
  "viewType": "PROJECTS"
}

Response

OK

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

    • 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

    • info

      the request property default value was added

    • info

      the request property default value was added