Skip to main content
POST
whatsapp.business-profile.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string

The sending account, from social.accounts.list. Optional when only one is connected.

Required string length: 1 - 256

Response

The result

websites
any[]
required

Business websites, up to two.

Maximum array length: 2
address
string

Business address.

Required string length: 1 - 512
email
string<email>

Business contact email.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
description
string

Business description.

Required string length: 1 - 512
industry
string

Business industry.

Required string length: 1 - 128
about
string

Business about text.

Maximum string length: 512