---
title: "Role"
description: "A custom role that can be used to assign set of permissions to members."
image: "https://developer.sumup.com/og/index.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.sumup.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: SumUp REST API

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

## Fields

- `id` (`Role.id`; string, required) — Unique identifier of the role.
  - example `"role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"`
- `name` (`Role.name`; string, required) — User-defined name of the role.
  - example `"Senior Shop Manager II"`
- `permissions` (`Role.permissions`; array<string>, required) — List of permission granted by this role.
  - example `[]`
- `is_predefined` (`Role.is_predefined`; boolean, required) — True if the role is provided by SumUp.
  - example `true`
- `created_at` (`Role.created_at`; string, required) — The timestamp of when the role was created.
  - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `updated_at` (`Role.updated_at`; string, required) — The timestamp of when the role was last updated.
  - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `description` (`Role.description`; string, optional) — User-defined description of the role.
  - example `"Manges the shop and the employees."`
- `metadata` (`Role.metadata`; object, optional) — 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 `{}`


Source: https://developer.sumup.com/api/schemas/Role/index.md