Graph API Version

Whatsapp Business Account (whatsapp_business_account)

Category of updates relating to a WhatsApp business account.

account_alerts

WhatsAppBusinessAccountAlertsField

Fields

FieldDescription

field

string

Name of the updated field

business_capability_update

Field node for notifying businesses about their capability changes.

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

max_daily_conversation_per_phone

int32

Indicates the number of template messages you can send with each of your WhatsApp Business Account's business phone numbers that have an approved display name. See Messaging Limits.

max_phone_numbers_per_waba

int32

The maximum number of phone numbers each WhatsApp Business Account can have. Either this field or max_phone_numbers_per_business will be present.

max_phone_numbers_per_business

int32

The maximum number of phone numbers each business can have. Either this field or max_phone_numbers_per_waba will be present.

message_echoes

WhatsAppBusinessAccountMessageEchoesField

Fields

FieldDescription

field

string

Name of the updated field

message_template_quality_update

WhatsAppBusinessAccountMessageTemplateQualityUpdateField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

previous_quality_score

enum

previous_quality_score

new_quality_score

enum

new_quality_score

message_template_id

integer

message_template_id

message_template_name

string

message_template_name

message_template_language

string

message_template_language

message_template_status_update

WhatsAppBusinessAccountMessageTemplateStatusUpdateField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

event

enum

event

message_template_id

integer

message_template_id

message_template_name

string

message_template_name

message_template_language

string

message_template_language

reason

enum

reason

disable_info

object

disable_info

disable_date

string

disable_date

other_info

object

other_info

title

enum

title

description

string

description

messages

WhatsAppBusinessAccountMessagesField

Fields

FieldDescription

field

string

Name of the updated field

messaging_handovers

WhatsAppBusinessAccountMessagingHandoversField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

phone_number_name_update

WhatsAppBusinessAccountPhoneNumberNameUpdateField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

display_phone_number

string

display_phone_number

decision

enum

decision

requested_verified_name

string

requested_verified_name

rejection_reason

enum

rejection_reason

phone_number_quality_update

WhatsAppBusinessAccountPhoneNumberQualityUpdateField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

display_phone_number

string

display_phone_number

event

enum

event

current_limit

enum {TIER_50, TIER_250, TIER_1K, TIER_10K, TIER_100K, TIER_UNLIMITED}

current_limit

old_limit

enum {TIER_50, TIER_250, TIER_1K, TIER_10K, TIER_100K, TIER_UNLIMITED}

old_limit

account_review_update

WhatsAppBusinessAccountReviewUpdateField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

decision

enum

decision

smb_message_echoes

WhatsAppBusinessAccountSMBMessageEchoesField

Fields

FieldDescription

field

string

Name of the updated field

value

object

Value will contain the full message echoes json structure

metadata

object

metadata

errors

list<WhatsAppBusinessAccountUnknownMessagesData>

errors

message

string

message

error_data

object

error_data - this object would contain details

details

string

details

message_echoes

list<WhatsAppBusinessAccountAbstractMessageEchoesData>

message_echoes

from

string

from

to

string

to

id

string

id

timestamp

string

timestamp

text

object

text

interactive

object

interactive

body

object

body

type

string

type

text

string

text

title

string

title

subtitle

string

subtitle

image

object

image

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

video

object

video

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

footer

object

footer

type

string

type

text

string

text

title

string

title

subtitle

string

subtitle

image

object

image

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

video

object

video

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

header

object

header

type

string

type

text

string

text

title

string

title

subtitle

string

subtitle

image

object

image

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

video

object

video

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

header_product

object

header_product

product_retailer_id

string

product_retailer_id

product

object

product

retailer_id

string

retailer_id

title

string

title

description

string

description

currency_code

string

currency_code

price_amount

integer

price_amount

sale_price_amount

integer

sale_price_amount

url

string

url

sections

list<WhatsAppBusinessAccountInteractiveListSectionData>

sections

rows

list<WhatsAppBusinessAccountInteractiveListRowData>

rows

description

string

description

id

string

id

title

string

title

product_items

list<WhatsAppBusinessAccountInteractiveListProductItemData>

product_items

product_retailer_id

string

product_retailer_id

title

string

title

interactive_message

object

interactive_message

native_flow_message

object

native_flow_message

buttons

list<WhatsAppBusinessAccountNativeFlowButtonData>

buttons

name

string

name

button_params_json

string

button_params_json

message_params_json

string

message_params_json

message_version

integer

message_version

catalog_id

string

catalog_id

type

string

type

cards

list<WhatsAppBusinessAccountInteractiveCarouselCardData>

cards

card_index

int32

card_index

type

string

type

action

object

action

product_retailer_id

string

product_retailer_id

catalog_id

string

catalog_id

location

object

location

errors

list<WhatsAppBusinessAccountUnknownMessagesData>

errors

message

string

message

error_data

object

error_data - this object would contain details

details

string

details

system

object

system

type

string

type

image

object

image

document

object

document

voice

object

voice

audio

object

audio

video

object

video

sticker

object

sticker

button

object

button

contacts

list<WhatsAppBusinessAccountContactsMessagesData>

contacts

reaction

object

reaction

message_id

string

message_id

emoji

string

emoji

order

object

order

catalog_id

string

catalog_id

text

string

text

product_items

list<WhatsAppBusinessAccountOrderMessageProductItemData>

product_items

product_retailer_id

string

product_retailer_id

quantity

int32

quantity

item_price

float

item_price

currency

string

currency

biz_opaque_callback_data

string

biz_opaque_callback_data

template

object

template

body

object

body

type

string

type

text

string

text

image

object

image

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

video

object

video

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

footer

object

footer

type

string

type

text

string

text

image

object

image

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

video

object

video

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

header

object

header

type

string

type

text

string

text

image

object

image

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

video

object

video

link

string

link

mime_type

string

mime_type

sha256

string

sha256

caption

string

caption

file_size

string

file_size

id

string

id

buttons

list<WhatsAppBusinessAccountTemplateMessageButtonData>

buttons

id

string

id

type

string

type

button_text

string

button_text

url

string

url

type

string

type

security

WhatsAppBusinessAccountSecurityField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

display_phone_number

string

A phone number that triggered the notification.

event

enum

An event happened in a phone number.

requester

string

ID of a business user who requested disable, disabled or updated two-step verification code.

account_update

WhatsAppBusinessAccountUpdateField

Fields

FieldDescription

field

string

Name of the updated field

value

object

value

phone_number

string

Phone number

event

enum

Account Update Event

ban_info

object

Ban info

waba_ban_state

enum

waba_ban_state

waba_ban_date

string

waba_ban_date

violation_info

object

Information about a violation on the account

violation_type

enum

The type of violation

lock_info

object

Lock info

expiration

datetime

The expiration of the lock

restriction_info

list<WhatsAppBusinessAccountUpdateRestrictionFieldData>

Information about the restrictions on the account

restriction_type

enum

restriction_type

expiration

datetime

expiration

business_verification_status

enum

Business verification status