WAPIsv2.0.0User
Update Phone
Update the authenticated user's phone number
Update the phone number for the authenticated user's account.
Endpoint
PATCH /user/phone| Access | Requirement |
|---|---|
| Authenticated | Yes |
| Required Scope | wapi-user-update, or wapi-user-all |
| Rate Limit | 5 requests per minute |
Request
Headers
| Header | Value |
|---|---|
Accept | application/json |
Authorization | Bearer <access_token> |
X-WAPI-Key | wapi_live_<kid>_<secret> or wapi_test_<kid>_<secret> |
Send exactly one of Authorization or X-WAPI-Key.
Body (form-data)
| Parameter | Type | Required | Description |
|---|---|---|---|
phone | string | Yes | New phone number |
Notes:
- The phone number must contain only digits, hyphens, plus signs, spaces, and parentheses.
- The number is validated against the platform's country code using international phone number rules.
Responses
200 OK
{
"message": "OK"
}400 Bad Request
{
"message": "The phone format is invalid."
}401 Unauthorized
{
"message": "Unauthorized"
}403 Forbidden
{
"message": "Invalid scope(s) provided."
}Example
curl -X PATCH "https://ttsb.wipayfinancial.com/wapi/user/phone" \
-H "Accept: application/json" \
-H "Authorization: Bearer <access_token>" \
-F "phone=+18687778899"