Update aggregate usage
PATCH/v1/user-settings/aggregate-usage
Enables or disables aggregate usage for the authenticated user. When disabled is true, duration (in minutes) is required and aggregate usage is automatically re-enabled after that duration expires. When disabled is false, duration cannot be passed.
Request
Header Parameters
- application/json
Body
required
Whether aggregate usage should be disabled.
Possible values: > 0
The duration in minutes for which aggregate usage should be disabled. Required when disabled is true; must not be provided when disabled is false.
Responses
- 200
- 400
- 401
- 403
- 500
Aggregate usage has been successfully updated.
- application/json
- Schema
- Example (from schema)
Schema
The new aggregate usage state for the user.
{
"disabled": true
}
Invalid request for example: Invalid parameters, missing parameters.
Unauthorized. This error will occur if calling user does not have access right for the API.
Forbidden. This error will occur if the user lacks the proper roles or permissions to perform this action.
A server error occurred. Check the logs for more details.