Skip to content

Channel Profile Update

POST
/platform/v1/channels/{channel_id}/profile
curl --request POST \
--url https://example.com/platform/v1/channels/1/profile \
--header 'Content-Type: application/json' \
--data '{ "about": "example", "address": "example", "description": "example", "email": "example", "profile_picture_handle": "example", "vertical": "example", "websites": [ "example" ] }'

Update the WhatsApp business profile. Only the provided fields are sent to Meta (exclude_none=True); omitted fields are left unchanged.

channel_id
required
Channel Id
integer
Media type application/json
PlatformBusinessProfileUpdate

POST body for POST /platform/v1/channels/{id}/profile.

Every field is optional — only the provided fields are sent to Meta (exclude_none=True in the router). messaging_product is injected by the service layer.

object
about
Any of:
string
<= 139 characters
address
Any of:
string
<= 256 characters
description
Any of:
string
<= 256 characters
email
Any of:
string
<= 128 characters
profile_picture_handle
Any of:
string
vertical
Any of:
string
websites
Any of:
Array<string>
<= 2 items
Example generated
{
"about": "example",
"address": "example",
"description": "example",
"email": "example",
"profile_picture_handle": "example",
"vertical": "example",
"websites": [
"example"
]
}

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}