userCapacities

Updates the capacity of the specified user.

Changed on

Updates the capacity of the specified user. The capacity is stored for the user's planning. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

put/users/{userId}/capacity

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users/{userId}/capacity
  • Auth: HTTP bearer

Path parameters

userIdstring uuid required

The user whose capacity should be updated.

Request body

capacityPerWeekinteger nullable

Backward compatibility property. The capacity of the user per week, in seconds. If this value is null, and all the daily values are null as well, then the default value will be set to the default value.

moninteger nullable

The user's capacity on Monday, in seconds.

tueinteger nullable

The user's capacity on Tuesday, in seconds.

wedinteger nullable

The user's capacity on Wednesday, in seconds.

thuinteger nullable

The user's capacity on Thursday, in seconds.

friinteger nullable

The user's capacity on Friday, in seconds.

satinteger nullable

The user's capacity on Saturday, in seconds.

suninteger nullable

The user's capacity on Sunday, in seconds.

Response

OK

userIdstring uuid

The id of the user this capacity belongs to.

createdOnstring date-time

The date this user capacity was created.

createdBystring uuid

The id of the user who created this user capacity.

updatedOnstring date-time

The date when this user capacity was last updated.

updatedBystring uuid

The id of the user who updated the user capacity.

capacityPerWeekinteger

The capacity of the user per week, in seconds.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutUserCapacityByUserId removed and replaced with userCapacities_PutUserCapacityByUserId