Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
client

[BETA] get business profile

Retrieve a business profile. Defaults to the authenticated account. Only WhatsApp Business accounts expose a profile. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/get-business-profile

Path parameters

idinteger required

Instance ID

Request body

userIdstring

Optional serialized contact ID. Omit to query the current account.

withComplianceboolean

Optional. Request compliance-augmented profile.

Response

Business profile retrieved successfully

instanceIdstring

ID of the instance

status'success' | 'error'

Example response

{
  "instanceId": "1",
  "status": "success"
}