Update Phone Number Details

put

https://api.in.kaleyra.io/v2/{sid}/whatsapp/{waba_id}/number/update

PUT Method

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Update Phone Number DetailsAPI allows you to modify your existing phone number and ensure your contact information remains accurate and up to date.
You can update both the WhatsApp business phone numbers associated with a Kaleyra V1 API WABA and with a Kaleyra V2 API WABA. You can check to which API version your WABA is associated with in the WhatsApp section of your Kaleyra CpaaS account.

Path Params

sid

string

required

Security Identifier for the account

waba_id

string

required

WhatsApp Business Account ID

Body Params

Request body for updating WhatsApp Business phone number details.

phone_number

string

required

WhatsApp Business phone number whose details need to be updated. Number must contain country code.

address

string

length ≤ 256

Business address. Maximum 256 characters allowed.

description

string

length ≤ 256

Business description. Maximum 256 characters allowed.

about

string

length ≤ 139

Business about information. Maximum 139 characters allowed.

string

Valid business email address.

category

string

enum

Business category.

incoming_url

string

Incoming URL where incoming message status updates are sent. Applicable only for V1 phone numbers.

callback_profile_id

string

Callback profile ID created on Kaleyra platform. Applicable for incoming messages on V2 phone numbers.

outgoing_callback_profile_id

string

Outgoing callback profile ID created on Kaleyra platform.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Request Processed Successfully

400Validation failure.

401Authentication or WABA validation failure.

500internal server error.