v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
User

Request User Phone Number Update

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint gives Astra's customers the ability to submit a phone number change request on behalf of a User to Astra, which will be sent through security checks on our end. This ensures that we can safely and securely update a User's phone number and verify that they are the owner.

📘

Astra allows for a maximum of 1 phone change request to be performed every 30 days for each User. If a User's phone number was updated on January 10, 2026, then the earliest the User's phone number can be changed again is after February 9, 2026.

📘

Phone number change requests can be rejected if our systems and our team are unable to verify phone ownership.

📘

Phone number change requests are typically processed within one business day, but processing times may vary.

❗️

Updating a User’s phone number does not update their UserIntent phone number. If a User’s Phone Number is successfully updated and if your program is leveraging Astra’s Web SDK, you’ll need to replace the user_intent_id query string parameter with the user_id query string parameter. In addition, including phone and phone_read_only query string parameters are highly recommended. Please ensure the phone number is derived from the User record, not the UserIntent record.

post/v1/request_user_phone_number_update

Request body

proposed_phonestring

The new phone number you would like to associate with the Astra User's profile

Example request

{
  "proposed_phone": "+15558675309"
}

Response

Successful response