--- title: Update User Phone Number slug: api-documentation/update-user-phone-number docTags: createdAt: 2026-08-27T16:18:26.773Z --- { "id": "oT9hGmH4Y8gJIG5UJQLkY", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.upstartcommerce.com/v1/user/{userId}/phone", "servers": [ { "url": "https://api.upstartcommerce.com/v1/user/{userId}/phone" } ], "name": "Update User Phone Number", "description": "

Update a user's phone number. This triggers:

\n
    \n
  1. Security alert email to the user
    2. \n
  2. Security alert SMS to the old phone (if verified)
    3. \n
  3. Verification flow for the new phone number
    4. \n
\n

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

\n

Required permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "userId", "type": "string", "description": "This is the path parameter indicating the user to be interacted with." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "New phone number", "customType": "UpdatePhoneNumberRequest", "schema": [ { "name": "newPhoneNumber", "kind": "required", "type": "string", "description": "New phone number to set. Accepts common US formats or E.164 format.", "example": "(555) 999-8888" } ], "modelRef": "#/components/schemas/UpdatePhoneNumberRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "SessionIdAccess", "name": "X-Upstart-Session-Id", "kind": "optional", "type": "apiKey", "description": "

Session based authorization. This authentication is required for clients to interact with any of the management APIs. Similar to ''LoggedIn'', it indicates that the user has actually logged into the system, but in this case with a management role.

", "in": "header" }, { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

(DEPRECATED) This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Phone number update initiated. User must verify the new number.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response after initiating phone number update", "customType": "UpdatePhoneNumberResponse", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "Status message", "example": "Phone number update initiated. Please verify your new number." }, { "name": "verificationRequired", "kind": "required", "type": "boolean", "description": "Whether the new phone number needs verification", "example": true }, { "name": "maskedNewPhone", "kind": "optional", "type": "string", "description": "Masked new phone number for display", "example": "***-***-8888" } ], "modelRef": "#/components/schemas/UpdatePhoneNumberResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Details of a request that failed validation.", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Credentials are missing, expired or insufficient (HTTP 401).

", "customType": "UnauthorizedError", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/UnauthorizedError", "isExpanded": true } ] }, { "statusCode": "403", "description": "

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

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

The request is understood but refused (HTTP 403).

", "customType": "ForbiddenError", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ForbiddenError", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

The addressed resource does not exist (HTTP 404).

", "customType": "NotFoundError", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/NotFoundError", "isExpanded": true } ] }, { "statusCode": "409", "description": "The request conflicts with the current state of the resource.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

The request conflicts with existing state (HTTP 409).

", "customType": "ConflictError", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ConflictError", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

The request failed for an unexpected reason (HTTP 500).

", "customType": "InternalServerError", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/InternalServerError", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "N4rVhckbWpUM-UWQYemvN", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https://api.upstartcommerce.com/v1/user/{userId}/phone \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"newPhoneNumber\": \"(555) 999-8888\"\n }'" }, { "id": "axYI_jVp8I2Wm1W16dbwK", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"newPhoneNumber\": \"(555) 999-8888\"\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/user/{userId}/phone\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "4lOyWSIS0Q3kEhxrO71xT", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/user/{userId}/phone\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"newPhoneNumber\": \"(555) 999-8888\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "idtyMUJs-zNsNHytdnkvV", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/user/{userId}/phone\"\n\npayload = json.dumps({\n \"newPhoneNumber\": \"(555) 999-8888\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "N4rVhckbWpUM-UWQYemvN" }, "results": { "languages": [ { "id": "NE_o54TJt0FQA_6A-BkYH", "language": "200", "code": "// Phone number update initiated. User must verify the new number.\n{\n \"message\": \"Phone number update initiated. Please verify your new number.\",\n \"verificationRequired\": true,\n \"maskedNewPhone\": \"***-***-8888\"\n}" }, { "id": "9IAHgpP9uMSEJkFIUAf4H", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": [\n \"\"\n ],\n \"reason\": \"\"\n}" }, { "id": "9hp8gjtY0jbuAXHhuoCjL", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "A7TgjfP44XINcW2DHtTB7", "language": "403", "code": "// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "MvTiYEc51YAQKcQZtCO4x", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "7bmCCR5Pbuo7c6rlUp-eb", "language": "409", "code": "// The request conflicts with the current state of the resource.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "W0D9dLqgxWjxEysc4NhPT", "language": "500", "code": "// Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "NE_o54TJt0FQA_6A-BkYH" } }, "children": [ { "text": "" } ] }