Users

Update User Details

Changed on Oct 30, 2020

Update the profile details for the given user

When updating Payor users with the role of payor.master_admin a verificationCode is required

post/v2/users/{userId}/userDetailsUpdate

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

primaryContactNumberstring nullable

The main contact number for the user

secondaryContactNumberstring nullable

The secondary contact number for the user

firstNamestring nullable

lastNamestring nullable

emailstring email nullable

the email address of the user

smsNumberstring nullable

The phone number of a device that the user can receive sms messages on

mfaType'SMS' | 'YUBIKEY' | 'TOTP' nullable

The type of the MFA device

verificationCodestring nullable

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

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "primaryContactNumber": "11235555555",
  "mfaType": "TOTP",
  "smsNumber": "11235555555",
  "secondaryContactNumber": "11235555550",
  "email": "foo@example.com",
  "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
- 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
  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/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
- info
  response property errors/items/reasonCode deprecated
Aug 13, 202075bb7af5ae63 Revision changes
- warning
  changed the pattern of the request property from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
- warning
  changed the pattern of the request property from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
- warning
  changed the pattern of the request property from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$

Operation history (5 revisions)