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

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
address
string

First address line.

Required string length: 1 - 512
addressLine2
string

Second address line.

Required string length: 1 - 512
city
string

Business city.

Required string length: 1 - 128
region
string

State or region.

Required string length: 1 - 128
postalCode
string

Postal code.

Required string length: 1 - 32
country
string

Business country.

Required string length: 1 - 128
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
websites
string[]

Up to two websites; an empty array clears them.

Maximum array length: 2
about
string

About text; empty clears it.

Maximum string length: 512

Response

The result

updated
boolean
required

All requested updates were accepted.