Roles

Deactivate a role by ID

Deactivates the role specified by its ID. The role remains queryable with status DEACTIVATED. Only roles whose entity_type is BUSINESS may be deactivated via this endpoint; account-group roles are rejected with 403 Forbidden. Deactivation is a terminal state; once deactivated, a role cannot be reactivated. Deactivation is idempotent: calling this endpoint on an already-deactivated role returns 202 Accepted without side effects. A ROLE.DEACTIVATED webhook event is emitted on the first successful deactivation.

delete/roles/{role_id}

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/roles/{role_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: roles:admin)

Response

The request has been successfully accepted and will be processed asynchronously.

Changes

No recorded changes to this operation across all 25 revisions of this API.