---
updatedAt: 2025-09-18T11:33:46.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Get WhatsApp Profile Display Name

This API retrieves the current display name for a WhatsApp application. 

# Request Example

```curl
curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/profile/displayName' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}'
```

<br />

# Response Example

```curl
{
  "displayNameInfo": {
    "verifiedNameStatus": "",
    "requestedName":"",
    "requestedNameStatus":"",
    "verifiedName":""
  },
  "status": "success"
}
```

<br />

# Status Codes

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Status Code
      </th>

      <th>
        Response
      </th>

      <th>
        Comments
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        200
      </td>

      <td>
        `{
                          "displayNameInfo": {
                            "verifiedNameStatus": "",
                            "requestedName":"",
                            "requestedNameStatus":"",
                            "verifiedName":""
                          },
                          "status": "success"
                  }`
      </td>

      <td>
        `verifiedName` - current name if `verifiedNameStatus` is APPROVED

        `requestedName` - display name requested in update display name call

        `requestedNameStatus` - requested display name status
      </td>
    </tr>

    <tr>
      <td>
        400
      </td>

      <td>
        `{ 
                          "status": "error", 
                          "message": "Invalid request parameters" 
                  }`
      </td>

      <td>
        Missing or invalid parameters
      </td>
    </tr>

    <tr>
      <td>
        401
      </td>

      <td>
        `{ 
                          "status": "error", 
                          "message": "Unauthorized" 
                 }`
      </td>

      <td>
        Invalid or missing authentication token
      </td>
    </tr>

    <tr>
      <td>
        403
      </td>

      <td>
        `{ 
                          "status": "error", 
                          "message": "Forbidden - no permissions to access resource" 
                  }`
      </td>

      <td>
        User does not have admin privileges
      </td>
    </tr>

    <tr>
      <td>
        500
      </td>

      <td>
        `{ 
                         "status": "error",
                         "code": "INTERNAL_SERVER_ERROR", 
                         "message": "An unexpected error occurred" 
                }`
      </td>

      <td>
        For any internal error
      </td>
    </tr>
  </tbody>
</Table>

<br />

<br />

# Request Parameters

<br />

| Key                 | Description                               | Values                                 | Data Type | Required/Optional | Constraints                                      |
| :------------------ | :---------------------------------------- | :------------------------------------- | :-------- | :---------------- | :----------------------------------------------- |
| **Path Parameters** |                                           |                                        |           |                   |                                                  |
| appId               | The unique identifier for the application | 57d9179b-7412-4621-bf86-57ee1962fd12   | String    | Required          | Must be a valid app ID                           |
| **Request Headers** |                                           |                                        |           |                   |                                                  |
| Authorization       | Partner App token for authentication      | sk\_JhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 | String    | Required          | Must be a valid JWT token with PARTNER\_APP role |

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Profile Name Managament APIs",
    "description": "APIs for retrieving and updating WhatsApp app display name.\nThese APIs allow partners to manage their WhatsApp business profile display name.\n",
    "version": "1.0.0",
    "contact": {
      "name": "Gupshup Partner Portal Team"
    }
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io/partner/app",
      "description": "Partner Portal API Base URL"
    }
  ],
  "tags": [
    {
      "name": "WhatsApp Profile",
      "description": "WhatsApp Profile Management APIs"
    }
  ],
  "paths": {
    "/{appId}/profile/displayName": {
      "get": {
        "tags": [
          "WhatsApp Profile"
        ],
        "summary": "Get WhatsApp Profile Display Name",
        "description": "This API retrieves the current display name for a WhatsApp application. \nThe display name is an important identifier for the business on WhatsApp. \nPartner App privileges are required to access this endpoint, and the API key \nmust be associated with the specified app ID.\n",
        "operationId": "getProfileName",
        "parameters": [
          {
            "name": "appId",
            "in": "path",
            "description": "The unique identifier of the WhatsApp application",
            "required": true,
            "schema": {
              "type": "string",
              "example": "57d9179b-7412-4621-bf86-57ee1962fd12"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "Partner App token for authentication",
            "required": true,
            "schema": {
              "type": "string",
              "example": "sk_JhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
            }
          }
        ],
        "security": [
          {
            "PartnerAppAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetProfileNameResponse"
                },
                "example": {
                  "displayNameInfo": {
                    "verifiedNameStatus": "",
                    "requestedName": "",
                    "requestedNameStatus": "",
                    "verifiedName": ""
                  },
                  "status": "success"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid request parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "status": "error",
                  "message": "Invalid request parameters"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Invalid or missing authentication token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "status": "error",
                  "message": "Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - No permissions to access resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "status": "error",
                  "message": "Forbidden - no permissions to access resource"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "status": "error",
                  "message": "Internal server error. Please try again later and If Issue still persist than contact Gupshup Dev Support"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "GetProfileNameResponse": {
        "type": "object",
        "properties": {
          "displayNameInfo": {
            "type": "object",
            "properties": {
              "verifiedNameStatus": {
                "type": "string",
                "description": "Status of the verified name"
              },
              "requestedName": {
                "type": "string",
                "description": "Name that was requested for verification"
              },
              "requestedNameStatus": {
                "type": "string",
                "description": "Status of the requested name"
              },
              "verifiedName": {
                "type": "string",
                "description": "The verified name if available (current name if verifiedNameStatus is APPROVED)"
              }
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "success"
            ],
            "description": "Status of the API call"
          }
        },
        "required": [
          "displayNameInfo",
          "status"
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "error"
            ],
            "description": "Error status"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        },
        "required": [
          "status",
          "message"
        ]
      }
    },
    "securitySchemes": {
      "PartnerAppAuth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "Partner App token for authentication (JWT token with PARTNER_APP role)"
      }
    }
  }
}
```