Substy Developers
Team

Update team role

Replace an editable agency role's name, presentation, permission set and data-visibility settings. Changes affect members assigned to the role.

PATCH/v1/agencies/{agencyId}/team/roles/{roleId}

Replace an editable agency role's name, presentation, permission set and data-visibility settings. Changes affect members assigned to the role.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
roleId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/agencies/string/team/roles/string" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "color": "string",    "permissions": [      "fan:view"    ],    "dataVisibility": "SELF"  }'
{  "data": {    "members": [      {        "employeeId": "string"      }    ],    "description": null,    "agencyId": "string",    "permissions": [      "string"    ],    "dataVisibility": "SELF",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "name": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "color": "string",    "isSystem": true,    "isDefault": true  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

List team role audit events GET

List agency role and permission audit events with actor, action, permission and date filters. Use the numeric cursor as an offset for later pages.

Delete team role DELETE

Delete an editable agency role and provide a replacement role for its affected members.