Roles

Update a role

Update a custom role.

patch/v0.1/merchants/{merchant_code}/roles/{role_id}

Path parameters

merchant_codestring required

Example:MK10CL2A

Short unique identifier for the merchant.

role_idstring required

Example:role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP

The ID of the role to retrieve.

Request body

namestring

User-defined name of the role.

permissionsstring[]

User's permissions.

descriptionstring

User-defined description of the role.

Example request

{
  "name": "Senior Shop Manager III",
  "permissions": [
    "catalog_edit",
    "taxes_access",
    "members_edit"
  ]
}

Response

Returns the updated Role object if the update succeeded.

idstring required

Unique identifier of the role.

namestring required

User-defined name of the role.

descriptionstring

User-defined description of the role.

permissionsstring[] required

List of permission granted by this role.

is_predefinedboolean required

True if the role is provided by SumUp.

metadataMetadata

Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.

created_atstring date-time required

The timestamp of when the role was created.

updated_atstring date-time required

The timestamp of when the role was last updated.

Example response

{
  "id": "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
  "name": "Senior Shop Manager II",
  "description": "Manges the shop and the employees.",
  "permissions": [],
  "is_predefined": true,
  "metadata": {},
  "created_at": "2023-01-20T15:16:17Z",
  "updated_at": "2023-01-20T15:16:17Z"
}

Changes

Changed in 4 of the 53 revisions of this API.7

Jul 10, 2026c75ca16e1e442See the full diff
- ○
  the security scope roles.write was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope user.subaccounts was added to the endpoint's security scheme oauth2
  api-security-scope-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 11, 2026cd79d83b07e02See the full diff
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 404
  response-media-type-name-specialized
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2025b8fb7c9463b82See the full diff
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 404
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 202580a17713e7a81See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history