GUgupshup
WhatsApp Profile

Update WhatsApp Profile Display Name

This API updates the display name for a WhatsApp application. The display name is an important identifier for the business on WhatsApp. Partner App privileges are required to access this endpoint, and the API key must be associated with the specified app ID.

post/{appId}/profile/displayName

Request

  • Base URL
    https://partner.gupshup.io/partner/app
  • URL
    https://partner.gupshup.io/partner/app/{appId}/profile/displayName
  • Auth
    API key in header Authorization

Path parameters

appIdstring required
Example:57d9179b-7412-4621-bf86-57ee1962fd12

The unique identifier of the WhatsApp application

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Partner App token for authentication

Request body application/x-www-form-urlencoded

newDisplayNamestring required

The new display name for the WhatsApp application

Example request

{
  "newDisplayName": "Updated Business Name"
}

Response

Successfully updated display name

status'success' required

Status of the API call

Changes

No recorded changes to this operation across all 1 revision of this API.