Role | SumUp Developer

A custom role that can be used to assign set of permissions to members.

Fields

idstringrequired
Unique identifier of the role.

Example: "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
namestringrequired
User-defined name of the role.

Example: "Senior Shop Manager II"
permissionsarray<string>required
List of permission granted by this role.

Example: []
is_predefinedbooleanrequired
True if the role is provided by SumUp.

Example: true
created_atstringrequired
format: date-time
The timestamp of when the role was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequired
format: date-time
The timestamp of when the role was last updated.

Example: "2023-01-20T15:16:17Z"
descriptionstring
User-defined description of the role.

Example: "Manges the shop and the employees."
metadataobject
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.

Example: {}