deleteRole

DELETE

/api/v1/roles/{key}

const url = 'https://example.com/api/v1/roles/owner';
const options = {method: 'DELETE', headers: {'X-CSRF-Token': 'example'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/roles/owner \
  --header 'X-CSRF-Token: example'

Delete a custom role that no account holds. Requires the roles.manage capability and the admin scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Path Parameters

key

required

Role key. The built-in roles are owner, administrator, editor, contributor, and viewer. Custom role keys start with “custom.”. Decide authorization from the capabilities the server reports, not from the role key.

string

/^[a-z][a-z0-9.-]{1,63}$/

Header Parameters

X-CSRF-Token

required

string

Responses

204

Role deleted

401

Dashboard authentication required

403

Insufficient role or capability outside the caller’s authority

404

Role not found

409

Built-in role or role still assigned