Get WhatsApp display name

Returns the display name currently shown to end users next to messages from this app's WhatsApp number.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Sample cURL — Get WhatsApp display name.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/access/wa-display-name' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "displayNameInfo": {
      "verifiedName": "AcmeSupport",
      "verifiedNameStatus": "APPROVED",
      "requestedName": "Acme Care",
      "requestedNameStatus": "PENDING_REVIEW"
    }
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json