Update User Details

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

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

Changed in 6 of the 50 revisions of this API.10331

Sep 25, 2020dd71433847a6530See the full diff
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 400
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 404
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 409
  response-property-type-changed
- ○
  added the optional property errors/items/errorCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 409 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 409 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 409 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 409 status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 13, 202075bb7af5ae633See the full diff
- ●
  changed the pattern of the request property primaryContactNumber from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
  request-property-pattern-changed
- ●
  changed the pattern of the request property secondaryContactNumber from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
  request-property-pattern-changed
- ●
  changed the pattern of the request property smsNumber from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
  request-property-pattern-changed
Jun 24, 2020aded220b0d7b2See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 404
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 404
  response-property-type-changed
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 27, 20207c8cfeb599522See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 409
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 409
  response-property-type-changed
This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 28, 20201b2abf26b5d61See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 15, 2019ced8e167a97c1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history