Users

Update User Role

Changed on Oct 30, 2020

Update the user's Role

post/v2/users/{userId}/roleUpdate

Request

Base URL
https://api.sandbox.velopayments.com
Auth
OAuth 2
Client credentials
Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

userIdstring uuid required

The UUID of the User.

Request body

rolesstring[] required

The role(s) for the user The role must exist The role can be a custom role or a system role but the invoker must have the permissions to assign the role System roles are: backoffice.admin, payor.master_admin, payor.admin, payor.support

verificationCodestring nullable

Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them

Example request

{
  "roles": [
    "payor.admin"
  ],
  "verificationCode": "123456"
}

Response

request completed okay

Changes

Oct 30, 2020dd71433847a6 Revision changes
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  response property errors/items/locationType deprecated
- info
  response property errors/items/locationType deprecated
- info
  response property errors/items/locationType deprecated
- info
  response property errors/items/locationType deprecated
- info
  response property errors/items/reasonCode deprecated
- info
  response property errors/items/reasonCode deprecated
- info
  response property errors/items/reasonCode deprecated
- info
  response property errors/items/reasonCode deprecated
Jun 24, 2020aded220b0d7b Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  the / response's property type changed from object to no type for status

Operation history (3 revisions)