POpoll-the-people
Team Roles

Delete a custom role.

Changed on

Deletes a custom role belonging to this team. Reserved system roles cannot be deleted, and a role cannot be deleted while it still has members assigned, has pending invitations, or is set as an organization's default SSO role.

delete/api/v1/teams/roles/{roleId}

Request

Path parameters

roleIdinteger required

The unique role identifier.

Response

Custom role deleted successfully. It will no longer appear in GET /teams/roles results.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "deleted": true
  }
}

Changes