📘
Rate limited to 3 requests per day

Request Example

curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/profile/displayName' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'newDisplayName=Updated Business Name'

Request Example

{
    "status": "success"
}

Status Codes

Status Code	Response	Comments
200	`{ "status": "success" }`	Successfully updated display name
400	`{ "status": "error", "error": "Display name cannot be empty" }`	Display Name validations
400	`{ "status": "error", "error": "Display name must be at least 3 characters long" }`	Display Name validations
400	`{ "status": "error", "error": "Display name must be less than 250 characters" }`	Display Name validations
400	`{ "status": "error", "error": "Display name can only contain letters, numbers, spaces, hyphens, underscores, and parentheses" }`	Display Name validations
400	`{ "status": "error", "error": "Display name cannot be all uppercase. It must contain at least one lowercase letter or number" }`	Display Name validations
500	`{ "status": "error", "code": "INTERNAL_SERVER_ERROR", "message": "An unexpected error occurred" }`	For any internal error

Request Parameters

Key	Description	Values	Data Type	Required/Optional	Constraints
Path Parameters
appId	The unique identifier of the WhatsApp application	57d9179b-7412-4621-bf86-57ee1962fd12	String	Required	Must be a valid app ID
Form Parameters
newDisplayName	The new display name for the WhatsApp application	Updated Business Name	String	Required	Must comply with WhatsApp display name requirements
Request Headers
Authorization	Partner App token for authentication	sk_226b25558a19407c9d34845****b6b88	String	Required	Must be a valid JWT token with PARTNER_APP role