Delete Role

Delete a custom role that no member holds any more. Global roles can't be deleted.

DEL

Path

Path parameters

stringrequired

The role's id, from List Roles.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Response fields

idstring

The id of the resource that was deleted.

Try this request

API Key

Request

curl --request DELETE \
  --url 'https://connect.mindcloud.co/v2/roles/Rl5wB9cF3hJp' \
  --header 'Authorization: Bearer $MINDCLOUD_API_TOKEN'

{
  "success": true,
  "data": {
    "id": "Rl5wB9cF3hJp"
  }
}

View as Markdown