business

[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

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/action/get-business-profile
Auth: HTTP bearer

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

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Business profile retrieved successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success"
  },
  "status": "success"
}

Changes

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