updatePhoneNumber

client.updatePhoneNumber({
  accessToken: string,
  phoneNumber: string
})

About this command

Update the profile phone number and send a verification code by SMS.

  • The profile must have been granted the full_write scope at the last authentication.

  • It is required to configure and to enable the Verification SMS template in the account’s settings.

Examples

client.updatePhoneNumber({
  accessToken: 'eyJ0eXAiOiJKV1QiL...',
  phoneNumber: '+33606060606'
})

Parameters

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old.

phoneNumber string

The user’s phone number.

Both the international format and the national conventions of the account’s country are accepted if configured in account settings.

Response

Type: Promise[void]