v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Update Role

post/v1/permissions/sync

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

role_idstring required

ID of the role to be updated.

permissions_idsstring[] required

IDs of the permissions for the updated role. To obtain available IDs, execute a GET request at the /v1/permissions endpoint.

Response

200

Example response

{
  "data": {
    "object": "Role",
    "id": "jMKQazLERjRQaEmL",
    "name": "test",
    "description": "Test ert",
    "display_name": "sdfgfgd (api)",
    "created_at": 1728593548,
    "permissions": {
      "data": [
        {
          "object": "Permission",
          "id": "eYEdxMEoYeNMxozM",
          "name": "create-payment",
          "description": "Create a payment.",
          "display_name": "create payment",
          "permission_type": "Payment Management"
        }
      ]
    }
  }
}