UPupvest
Roles

Create a role

Changed on

Creates a role, assigning a user to an account group or business entity.

The entity_type parameter determines whether entity_id refers to an account group or a business, and constrains which role_type values are valid.

See the User roles guide (TOL / BYOL) for role types and assignment rules.

post/roles

Request

  • Base URL
    https://sandbox.upvest.co
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://sandbox.upvest.co/auth/token
    Scopesroles:admin

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

OR

Response

Role created.

OR

Changes

  • 85aff1852bf8Revision changes
    • warning

      added the new OWNER enum value to the // response property for the response status

    • info

      added the new OWNER enum value to the request property /