Update group access settings
Changes the fields you send and returns the full updated document.
Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.
Authentication
AuthorizationBearer
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Request
This endpoint expects an object.
version
Document version. On update, send back the num from your last read.
hide_details_enabled
If true, group details are hidden from the user after a successful add (e.g. ‘you can now receive emails from group_name@org.com’).
dl_group_validation_bender
Data mapping that validates and preprocesses the group email a user provides, for example adding a prefix or changing the domain. Replaced as a whole on update.
Response
The updated group access settings, at its new version
hide_details_enabled
If true, group details are hidden from the user after a successful add (e.g. ‘you can now receive emails from group_name@org.com’).
dl_group_validation_bender
Data mapping that validates and preprocesses the group email a user provides, for example adding a prefix or changing the domain. Replaced as a whole on update.
updated_time
When the configuration was last updated.
updated_by
Who last updated the configuration.
version
Document version. On update, send back the num from your last read.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error