Substy Developers
Team

Delete team role

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

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

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

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 DELETE "https://example.com/v1/agencies/string/team/roles/string" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "replacementRoleId": "string"  }'
{  "data": {    "success": true  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Update team role PATCH

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

Set default team role PUT

Choose the agency role used as the default for new memberships or invitations according to agency role rules.