CoworkerSettings
Update CoworkerSetting
Update an existing CoworkerSetting record.
PUT
Update CoworkerSetting
Updates an existing CoworkerSetting record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerSetting-Edit role.Request Body
Required Fields
The Id of the CoworkerSetting record to update.
The customer this setting belongs to.
The setting key name.
Optional Fields
The plain-text value for this setting.
An encrypted version of the setting value, used for sensitive data.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the coworkersetting was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update CoworkerSetting