API v1 ReferenceUser Capacities

Updates the capacity of the specified user.

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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequiredformat: "uuid"
The user whose capacity should be updated.

Request

Updated capacity values for each day of the week.
moninteger or nullOptional
The user's capacity on Monday, in seconds.
tueinteger or nullOptional
The user's capacity on Tuesday, in seconds.
wedinteger or nullOptional
The user's capacity on Wednesday, in seconds.
thuinteger or nullOptional
The user's capacity on Thursday, in seconds.
friinteger or nullOptional
The user's capacity on Friday, in seconds.
satinteger or nullOptional
The user's capacity on Saturday, in seconds.
suninteger or nullOptional
The user's capacity on Sunday, in seconds.
capacityPerWeekinteger or nullOptionalDeprecated
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.

Response

OK
userIdstringOptionalformat: "uuid"
The id of the user this capacity belongs to.
weeklyCapacityobjectOptional
createdOnstringOptionalformat: "date-time"
The date this user capacity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this user capacity.
updatedOnstringOptionalformat: "date-time"
The date when this user capacity was last updated.
updatedBystringOptionalformat: "uuid"
The id of the user who updated the user capacity.
capacityPerWeekintegerOptionalRead-onlyDeprecated
The capacity of the user per week, in seconds.

Errors

401
Unauthorized Error