Update Phone Number

Updates the user’s phone number on their existing cardholder record. Returns 404 if the user has no cardholder yet — this method never creates one.

If you require users to verify their phone, include code from POST /phone/verification; phone is optional. Otherwise send phone and omit code.

PATCH /phone

Update Phone Number

JavaScript

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone: '<string>', code: '<string>'})
};

fetch('https://core.prod.gnosispay.com/user-api/phone', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "success": true
}

Body

application/json

phone · string

Required unless you require phone verification and send code.

Required string length: 6 - 20

code · string

One-time SMS code from POST /phone/verification. Required if you require phone verification for your users; omit otherwise.

Required string length: 6

Pattern: ^[0-9]{6}$

Response

200

application/json

Phone number updated successfully

Phone number updated successfully

success · enum<boolean> · required

Available options: true