Update Group
PUT/api/groups/:key
Update the group with the given key.
You can find more information about groups here.
Locale
Group names and descriptions can be specified in multiples languages. These can be set when creating groups or through updates.
Note: A translation for the application's default locale must exist. You can learn more about configuring the default locale here.
The locale in the request body specifies which translation should be created.
The locale query parameter specifies which translation should be returned.
Tokens
- A valid
AccessTokenwithADMINpermissions is required.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Updated group information.
The following error codes correspond to this status:
INVALID_GROUP_TRANSLATION: Invalid group translation.
The following error codes correspond to this status:
ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.AUTHENTICATION_REQUIRED: User is not authenticated.
The following error codes correspond to this status:
ROLE_REQUIRED: Principal does not have required role.
The following error codes correspond to this status:
GROUP_NOT_FOUND: No group with specified key found.
The following error codes correspond to this status:
ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.DATABASE_FAILURE: Exception representing a general failure related to database operations.NO_TRANSLATIONS: Exception indicating that no translations are available for a given request.