Update User Phone Number

1 min

PUT

https://api.upstartcommerce.com/v1/user/{userId}/phone

Update a user's phone number. This triggers:

Security alert email to the user
Security alert SMS to the old phone (if verified)
Verification flow for the new phone number

The phone number must be re-verified after change before SMS MFA can be used.

Required permissions:

user.update or self-update via session

userIdstringThis is the path parameter indicating the user to be interacted with.

acceptstringGenerated from available response content types

x-upstart-tenantstringTenant identifier associated with the site this call is for.

bodyobjectNew phone number

200Phone number update initiated. User must verify the new number.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

403<p>An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.</p>

404The requested resource was not found in the NoChannel system.

409The request conflicts with the current state of the resource.

500Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.

curl --request PUT \
     --url https://api.upstartcommerce.com/v1/user/{userId}/phone \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "newPhoneNumber": "(555) 999-8888"
     }'