API v1 ReferenceUser Capacity

Updates the capacity of the specified user.

Updates the capacity of the user with the specified id. User planning data or admin permissions are required if the capacity of the specified user does not belong to the calling user.

Path parameters

userIdUUIDRequired

The id of the user.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
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

userIdUUIDOptional

The id of the user this capacity belongs to.

weeklyCapacityobjectOptional
createdOndatetimeOptional

The date this user capacity was created.

createdByUUIDOptional

The id of the user who created this user capacity.

updatedOndatetimeOptional

The date when this user capacity was last updated.

updatedByUUIDOptional

The id of the user who updated the user capacity.

capacityPerWeekintegerOptionalDeprecated

The capacity of the user per week, in seconds.