Custom Roles

Delete a custom role

Changed on

Deletes a custom role from the team. Fails with CustomRoleInUse if the role is still attached to any team members; reassign those members (e.g. via update_team_member_role) before retrying.

post/teams/{team_id}/delete_custom_role

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/teams/{team_id}/delete_custom_role
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

team_idinteger required

Team ID

Request body

idinteger required

Changes