Skip to main content
PATCH
/
whatsapp
/
phone_numbers
/
{phone_number}
/
profile
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const profile = await client.whatsapp.phoneNumbers.profile.update('phone_number');

console.log(profile.data);
{
  "data": {
    "id": "<string>",
    "record_type": "whatsapp_phone_number_profiles",
    "phone_number_id": "<string>",
    "display_name": "<string>",
    "profile_photo_url": "<string>",
    "category": "<string>",
    "about": "<string>",
    "description": "<string>",
    "email": "<string>",
    "website": "<string>",
    "address": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
phone_number
string
required

Phone number (E.164 format)

Body

application/json
​
display_name
string
​
about
string
Maximum string length: 139
​
description
string
Maximum string length: 512
​
category
string
​
email
string
​
website
string
​
address
string

Response

Updated profile

​
data
object