Skip to main content

deleteOrgRole

Deletes an organization role. Requires the 'manage_members' permission on the role's org (super admins bypass). DESTRUCTIVE: removes the role and unassigns it from all members. Returns false if the role does not exist.

deleteOrgRole(
  orgRoleId: BigInt!
  idempotencyKey: String
): Boolean!

Arguments​

deleteOrgRole.orgRoleId ● BigInt! non-null scalar​

Role id (org_role_id as a BigInt string).

deleteOrgRole.idempotencyKey ● String scalar​

Optional idempotency key. Recommended for retries: replaying with the same key and identical arguments returns the first result instead of re-applying; the same key with different arguments returns IDEMPOTENCY_CONFLICT. Keys expire after 24h.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.