This reference guide explains error messages and defines the Meta Business Extension API object fields and structure for various types.
Use this reference table as a summary that defines the objects and associated types for the Meta Business Extension.
Object | Description |
---|---|
Defines Meta Business Extension-specific flows, such as the features and settings used to configure for the seller. See supported fields. | |
Defines the settings for the end user's Meta presence. See supported fields. | |
Defines the business settings to configure for an end user. This includes Messenger, catalogs, and more. See supported fields. Each field includes a specific "type": |
Use this object to define Meta Business Extension-specific flows, such as the features and settings used to configure for the seller.
Field | Description |
---|---|
Type: setup | Required. Seller’s Meta setup, such as a their unique identifier ( |
Type: business_config | Required. Configuration object the Meta Business Extension uses to configure the Meta Business Extension workflow. See |
Type: boolean | Required. Set this value to |
Use this object to define the settings for the end user's Meta presence.
Field | Description |
---|---|
Type: string | Required. Unique business ID to represent your client's business. We use this as a unique identifier. For example, if the seller's company is called "Fubar", then "fubar-123" could be their |
Type: string | Required. The time zone in which the business is located. See possible time zone values. |
Type: string | Required. Three-letter ISO currency code for the business's catalog items default currency. See supported currency codes. |
Type: Enum {'ECOMMERCE', 'APPOINTMENTS', 'RESERVATIONS', 'FOOD_AND_DRINK', 'CREATIVE', 'ADS_TARGETING', 'LEAD_ADS', 'MEASUREMENT_AND_OPTIMIZATION'} | Required. Vertical associated with the business. See Verticals list. |
Type: string | Optional. Used when upgrading from Meta Business Extension, v1. Contact your Meta representative if you are migrating from v1 to v2. |
Type: string | Required for Domain used for Instagram manual approval. Example: |
Type: enum | Optional. Channel that provides a way for the partner to express intent for the user about features that require additional steps or constraints:
Partners should request the |
Type: string | Optional. Business Manager ID for user's existing business manager that a partner can pass in to preselect for the user in the setup flow. |
Type: string | Optional. Ad Account ID for user's existing ad account that a partner can pass in to preselect for the user in the setup flow. |
Type: string | Optional. Page ID for the user's existing Facebook Page that partner can pass in to preselect for the user in setup flow. |
Type: string | Optional. Instagram Business Profile ID for the user's existing Instagram Business Profile that a partner can pass in to preselect for the user in the setup flow. |
Type: string | Optional. Pixel ID for the user's existing Meta Pixel that a partner can pass in to preselect for the user in the setup flow. |
Type: string | Optional. Catalog ID for the user's existing catalog that a partner can pass in to preselect for the user in the setup flow. |
Type: string | Optional. Provide connection name where app name and |
Type: FBEFlowConfigData | Optional. This field can be used to specify settings for the |
Type: enum | Optional. This field can be used to default the business to a particular set of features to install first. Parameters include: ADS AR_COMMERCE CATALOG_ADS CHECKBOX_PLUGIN CHECKBOX_PLUGIN_MARKETING COLLABORATIVE_ADS CONVERSIONS_API CREATIVE CREATIVE_WITH_ASSETS CUSTOM_AUDIENCE CUSTOMER_DATA FB_SERVICES FB_SHOP IG_CREATORS_AS_SELLERS IG_SERVICES IG_SHOP LEAD_ADS MESSENGER_CHAT MESSENGER_MARKETING |
Type: enum | Optional. This field can be used to choose whether to show the business the minimal onboarding experience (for example the Feature menu). |
Input on these fields is ignored if the user doesn't have admin access or isn't eligible to be installed with other assets:
Use the FBEFlowConfigData
field to specify settings for the IG_CREATORS_AS_SELLERS
channel.
Field | Description |
---|---|
Type: integer | Optional. Number of items in the catalog to be shared/created with Meta. |
Type: enum | Optional. This field can be used to default the business to a particular set of features to install first. Parameters include: ADS AR_COMMERCE CATALOG_ADS CHECKBOX_PLUGIN CHECKBOX_PLUGIN_MARKETING COLLABORATIVE_ADS CONVERSIONS_API CREATIVE CREATIVE_WITH_ASSETS CUSTOM_AUDIENCE CUSTOMER_DATA FB_SERVICES FB_SHOP IG_CREATORS_AS_SELLERS IG_SERVICES IG_SHOP LEAD_ADS MESSENGER_CHAT MESSENGER_MARKETING |
Type: enum | Optional. This field can be used to choose whether to show the business the minimal onboarding experience (for example the Feature menu). |
Use the business_config
object to configure the business settings for an end user. This includes Messenger, and more. Each field includes a "type" linked to the respective tables below.
business_config
Field | Description |
---|---|
| Required. Information for the end user's business. |
| Optional. Messenger chat features on the end user's Facebook Page, such as |
Type: FBECatalogFeedConfigData | Optional. Determines whether Meta Business Extension should use a feed approach, which grabs catalog items from a |
Type: FBEPageCtaConfigData | Optional. End user's page's CTA button, such as |
Type: FBEPageCardConfigData | Optional. "Featured" services card on a page, such as |
Type: FBEIGCtaConfigData | Optional. Features for the Instagram call to action feature, such as |
| Optional. Features for the Messenger persistent menu feature, such as |
| Optional. Features to determine if the Messenger thread intent feature is enabled. Only applicable to the |
Use the FBEBusinessPropertiesConfigData object to configure the business's name.
Field | Description |
---|---|
Type: string | Required. Business's name. |
Use the FBECatalogFeedConfigData object to configure catalog feed or the "pull" method for updating the catalog. Pull is not usually recommended as it leads to stale inventories until subsequent pulls, but is useful for smaller, self-hosted businesses with a publicly accessible inventory file.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: string | Required. URL of a publicly hosted file containing the business's inventory (must be in a CSV, TSV, or XML format). |
Use the FBEPageCtaConfigData object to configure the page's call to action button. This refers to the actual text, url, and description.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: enum {'Book Now' | 'Buy Now' | 'Reserve' | 'Order Food'} | Required. Text to display on the business's Facebook Page CTA button. |
Type: string | Required. URL that the business's Facebook Page CTA button opens. |
Type: string | Required. Subtext displayed under the business's Facebook Page call to action button. Generally used for partner attribution, if desired; for example, 'Powered by Partner'. |
Use the FBEIGCtaConfigData object to configure the business's Instagram CTA button.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: enum {'Book Now' | 'Buy Now' | 'Reserve' | 'Order Food'} | Required. Text to display on the business's Instagram profile CTA button. |
Type: string | Required. URL that the business's Instagram profile CTA button opens. |
Use the FBEMessengerMenuConfigData object to configure the business's messsenger menu CTA button.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: enum {'Book Now' | 'Buy Now' | 'Reserve' | 'Order Food'} | Required. Text to display in the Messenger fixed menu button when a user messages the business. |
Type: string | Required. URL that the Messenger fixed menu button opens. |
Use the FBEPageCardConfigData object to enable the page card feature, which displays the featured services for businesses. Recommended for the APPOINTMENTS
vertical.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: enum {'See All'} | Required. Text to display in the bottom panel of the Featured Services page card that navigates to an external URL. Currently, only 'See All' is supported. |
Type: string | Required. URL that the bottom panel of the Featured Services page Card opens. |
Type: enum {'Book'} | Required. Text to display in the CTA button for each displayed item. Currently only 'Book' is supported. |
Use the FBEMessengerChatConfigData object to configure the page's messenger chat options.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: vec<string> | Required. List of valid URLs that can display the Customer Chat plugin. Each URL should be a valid URL, including the protocol ID. Example: Example: |
Use the FBEThreadIntentConfigData object to configure the messenger's response for user intent. Recommended for the APPOINTMENTS
vertical.
Field | Description |
---|---|
Type: boolean | Required. Flag to enable or disable the feature. |
Type: string | Required. URL that the Messenger suggestion sends to the user, from which the user can book an appointment with the business. |
Parameter | Description |
---|---|
Type: boolean | When |
Type: string | The type of items in the request ( |
Type: object | A JSON object containing all requests. |
Type: object | A JSON object containing fields and values for an item.
|
Type: string |
|
Type: string | Advertiser-supplied |
requests.data
for ServicesField and Type | Description |
---|---|
Type: string | Required. Third-party identifier for the service. |
Type: string | Required. Title of service. Maximum characters: 200 |
Type: string | Required. Short description for the service. Maximum length: 9999 |
Type: enum | Type of price of the service:
|
Type: string | Optional when Cost of the service. You must specify the value with an Example: |
Type: enum | If this is Type of duration of the service:
|
Type: int | Optional when Duration of the service. |
Type: string | Required. Link to business's website where someone can book the service. |
Type: integer | Optional. Index used to optionally maintain order relative to other services in the containing catalog. |
Type: object | Optional. Max items: 20 Image data for this service. You can provide up to 20 images for the service. Each image contains two fields: |
Field Name and Type | Description |
---|---|
Type: string | Required. URL of the service image. All images must be in JPG, GIF, or PNG format. |
Type: string | Optional. A string that represents what's in the service. There can be multiple tags associated with an image. |
The following table contains the acceptable values for the timezone
field.
Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville | America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral | Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon CET Chile/Continental Chile/EasterIsland CST6CDT Cuba EET Egypt Eire EST EST5EDT Etc/GMT Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad | Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich Factory GB GB-Eire GMT GMT-0 GMT+0 GMT0 Greenwich Hongkong HST Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya MET Mexico/BajaNorte Mexico/BajaSur Mexico/General MST MST7MDT Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC PST8PDT ROC ROK Singapore Turkey UCT Universal US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa UTC W-SU WET Zulu |