Retrieve WhatsApp Business Profile

GET 
/api/v2/instance/:instanceId/chat/business-profile

Get details of a WhatsApp Business account, including contact info, operational hours, and category.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Query Parameters

id stringrequired

Enter the "number" or the "remoteJid".

Responses

200

WABusinessProfileResponse

application/json

Schema

Schema

description stringrequired
email stringrequired
business_hours object
timezone stringrequired
config object[]required
Array [
day_of_week stringrequired
mode stringrequired
open_time numberrequired
close_time numberrequired
]
business_config object[]required
Array [
day_of_week stringrequired
mode stringrequired
open_time numberrequired
close_time numberrequired
]
website string[]required
category stringrequired
wid stringrequired
address stringrequired

Example (from schema)

{
  "description": "string",
  "email": "string",
  "business_hours": {
    "timezone": "string",
    "config": [
      {
        "day_of_week": "string",
        "mode": "string",
        "open_time": 0,
        "close_time": 0
      }
    ],
    "business_config": [
      {
        "day_of_week": "string",
        "mode": "string",
        "open_time": 0,
        "close_time": 0
      }
    ]
  },
  "website": [
    "string"
  ],
  "category": "string",
  "wid": "string",
  "address": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...