Scheduling

Update assignment

Changed on
patch/v1/workspaces/{workspaceId}/scheduling/assignments/recurring/{assignmentId}

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/scheduling/assignments/recurring/{assignmentId}
  • 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
assignmentIdstring required

Represents an assignment identifier across the system.

Example:5b641568b07987035750505e

Request body

billableboolean

Indicates whether assignment is billable or not.

endstring required

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

hoursPerDaynumber double

Represents assignment total hours per day.

includeNonWorkingDaysboolean

Indicates whether to include non-working days or not.

notestring

Represents an assignment note.

seriesUpdateOption'THIS_ONE' | 'THIS_AND_FOLLOWING' | 'ALL'

Valid series option

startstring required

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

startTimestring

Represents a start time in the hh:mm:ss format.

taskIdstring

Represents task identifier across the system.

Example request

{
  "end": "2021-01-01T00:00:00Z",
  "hoursPerDay": 7.5,
  "note": "This is a sample note for an assignment.",
  "seriesUpdateOption": "THIS_ONE",
  "start": "2020-01-01T00:00:00Z",
  "startTime": "10:00:00",
  "taskId": "56b687e29ae1f428e7ebe505"
}

Response

OK

billableboolean

Indicates whether assignment is billable or not.

hoursPerDaynumber double

Represents assignment total hours per day.

idstring

Represents assignment identifier across the system.

includeNonWorkingDaysboolean

Indicates whether assignment should include non-working days or not.

notestring

Represents assignment note.

projectIdstring

Represents project identifier across the system.

publishedboolean

Indicates whether assignment is published or not.

recurringRecurringAssignmentDtoV1 (unresolved $ref)
startTimestring

Represents start time in hh:mm:ss format.

taskIdstring

Represents task identifier across the system.

userIdstring

Represents user identifier across the system.

workspaceIdstring

Represents workspace identifier across the system.

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 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

    • 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