> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/en/strategies/meta-business/meta-ads/conversions-api-parameters.md). # Conversions API Parameters The **Meta Conversions API (CAPI)** allows events to be sent directly from the server to Meta, ensuring greater accuracy in measurement and campaign optimization, even in the face of limitations such as cookie blocking, ad blockers, or browser restrictions. The **Conversions API parameters** are essential for Meta to correctly use events in **ad delivery and results attribution**. *** ### What are the Conversions API parameters? The parameters include **all required event data** and other additional data that the Conversions API uses to: * Ad delivery optimization * Correct conversion attribution * Improvement of event quality (Event Match Quality) * Better campaign performance Currently, the Conversions API is compatible with events from: * 💬 **Messages for businesses** * 🌐 **Web** * 📱 **Apps** * 🗂 **Offline events** *** ### Required parameters according to event type #### Website events (Web) Events sent through the Conversions API for **websites** require the following: * `client_user_agent` * `action_source` * `event_source_url` These parameters help improve the quality of events used in ad delivery and can significantly improve campaign performance. *** #### Non-web events (App, Offline, Messages) For events that **are not web-based**, only the following is required: * `action_source` 📌 **Important:**\ By using the Conversions API, you agree that the value entered in the parameter `action_source` be **accurate and consistent with the actual source of the event**, to the best of your knowledge. *** ### Main body parameters (Payload) | Parameter | Description | | ----------------- | --------------------------------------- | | `date` | List of sent events | | `test_event_code` | Code used for testing in Events Manager | *** ### Customer information parameters (User Data) These parameters are used for **user identification and matching**. Whenever indicated, **SHA-256 hashing is required**. #### Data requiring hashing | Parameter | Description | | --------- | ------------- | | `in` | Email | | `ph` | Phone number | | `fn` | First name | | `ln` | Last name | | `ge` | Gender | | `db` | Date of birth | | `ct` | City | | `st` | State | | `zp` | Postal code | | `country` | Country | *** #### Recommended or non-hashed data | Parameter | Description | Hash | | --------------------- | --------------------- | ----------- | | `external_id` | Contact external ID | Recommended | | `client_ip_address` | Client IP address | ❌ | | `client_user_agent` | User agent | ❌ | | `fbc` | Click ID | ❌ | | `fbp` | Browser ID | ❌ | | `subscription_id` | Subscription ID | ❌ | | `fb_login_id` | Facebook login ID | ❌ | | `lead_id` | Lead ID | ❌ | | `page_id` | Page ID | ❌ | | `page_scoped_user_id` | Page-scoped user ID | ❌ | | `ctwa_clid` | Click ID for WhatsApp | ❌ | | `ig_account_id` | Instagram account ID | ❌ | | `ig_sid` | Instagram click ID | ❌ | #### Exclusive parameters for App | Parameter | Observation | | --------- | ------------------------- | | `anon_id` | Valid only for app events | | `madid` | Mobile advertiser ID | *** ### Server event parameters | Parameter | Description | | --------------------------------- | --------------------- | | `event_name` | Event name | | `event_time` | Event timestamp | | `user_data` | Customer data | | `custom_data` | Custom data | | `event_source_url` | Source URL | | `opt_out` | User consent | | `event_id` | Unique event ID | | `action_source` | Event source | | `data_processing_options` | Processing options | | `data_processing_options_country` | Country | | `data_processing_options_state` | State | | `referrer_url` | Referrer URL | | `customer_segmentation` | Customer segmentation | *** ### App data parameters | Parameter | | ------------------------------ | | `advertiser_tracking_enabled` | | `application_tracking_enabled` | | `extinfo` | | `campaign_ids` | | `install_referrer` | | `installer_package` | | `url_schemes` | | `windows_attribution_id` | | `anon_id` | | `madid` | | `vendor_id` | 📌 **Note:**\ See the official documentation for the **Meta Conversions API for app events** for details on correct integration, supported parameters, and best practices.\ 🔗 *** ### Standard parameters Meta provides a complete list of **standard parameters** that can be sent in events. Some examples: * `event_name` * `event_time` * `order_id` * `event_id` *** ### Original Event Data Parameters The original event data parameters include: * `event_name` * `event_time` * `order_id` * `event_id` They are essential for **deduplication** and correct attribution when used together with the Pixel. *** ## Standard parameters This table lists all standard parameters that users can send to Meta.
WebsiteAppOfflineDescription
availabilityfb_availabilityavailabilityThe value must be available_soon, for_rent, for_sale, off_market, recently_sold or sale_pending.
body_stylefb_body_stylebody_styleVehicle body style: CONVERTIBLE, COUPE, HATCHBACK, MINIVAN, TRUCK, SUV, SEDAN, VAN, WAGON, CROSSOVER or OTHER.
checkin_datefb_checkin_datecheckin_dateThe date on which the user wants to check in, in the hotel's time zone. We accept dates in the formats YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD and YYYY-MM-DDThh:mm:ssTZD.
cityfb_citycityEnter the city of the location of the user's intent.
condition_of_vehiclefb_condition_of_vehiclecondition_of_vehicleThe condition of the vehicle.
content_idsfb_content_idscontent_idsThe content identification numbers associated with the event, such as product SKUs for items in an event of type AddToCart.
content_typefb_content_typecontent_type

Should be set to product or product_group:

  • Use product if the keys you send represent products. The keys can be content_ids or contents.
  • Use product_group if the keys you send in content_ids represent product groups. Product groups are used to differentiate identical products that have variations, such as color, material, size, or print.
contentsfb_contentscontentsA list of JSON objects containing the product IDs associated with the event and information about the items. Available fields: id, quantity, item_price, delivery_category.
countryfb_countrycountryEnter the country of the location of the user's intent.
currencyfb_currencycurrencyRequired for purchase events. The currency of the value specified, if applicable. The value must be a valid three-digit currency code that follows the standard ISO 4217.
delivery_categoryfb_delivery_categorydelivery_category

Optional for purchase events. Delivery type for a purchase event. Supported values:

  • in_store: the customer needs to go into the store to get the purchased product.
  • curbside: the customer drives to a store and waits inside the vehicle to pick up the order.
  • home_delivery: the purchase is delivered to the customer's home.
departing_arrival_datefb_departing_arrival_datedeparting_arrival_dateThe date and time of arrival at the destination for the outbound trip.
departing_departure_datefb_departing_departure_datedeparting_departure_dateThe date and time the outbound trip starts.
destination_airportfb_destination_airportdestination_airportUse the official IATA code for the destination airport.
destination_idsfb_destination_idsdestination_idsIf you have a destination catalog, you can associate one or more destinations from that catalog with a specific hotel event.
dma_codefb_dma_codedma_codeThe code of the Designated Marketing Area (DMA) used to target offers to users.
drivetrainfb_drivetraindrivetrainVehicle drivetrain: 4X2, 4X4, AWD, FWD, RWD, OTHER or NONE.
exterior_colorfb_exterior_colorexterior_colorExterior color.
fuel_typefb_fuel_typefuel_typeVehicle fuel type: DIESEL, ELECTRIC, FLEX, GASOLINE, HYBRID, PETROL, PLUGIN_HYBRID, OTHER or NONE.
hotel_scorefb_hotel_scorehotel_scoreAn indicator that represents the relative value of this hotel for the advertiser compared to other hotels.
interior_colorfb_interior_colorinterior_colorThe interior color.
lead_event_sourcelead_event_sourcelead_event_sourceThe source of the lead event.
lease_end_datefb_lease_end_datelease_end_dateSpecified using the ISO 8601 date format: YYYY-MM-DD.
lease_start_datefb_lease_start_datelease_start_dateAllows property recommendations based on date availability (using available_dates_price_config in the catalog) and improved user experience (using model tags).
listing_typefb_listing_typelisting_typeThe value must be for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction or new_listing.
makefb_makemakeThe vehicle's make or manufacturer.
mileage.unitfb_mileage.unitmileage.unitThe mileage unit.
mileage.valuefb_mileage.valuemileage.valueThe mileage value.
modelfb_modelmodelThe vehicle model.
neighborhoodfb_neighborhoodneighborhoodThe neighborhood of interest.
net_revenuenet_revenuenet_revenueThe margin value of a conversion event.
num_adultsfb_num_adultsnum_adultsThe number of adults who will be staying.
num_childrenfb_num_childrennum_childrenThe number of children who will be staying.
num_infantsfb_num_infantsnum_infantsThe number of babies that will be accommodated.
num_itemsfb_num_itemsnum_itemsUse only with events InitiateCheckout. The number of items a user tries to buy during checkout.
order_idfb_order_idorder_idThe transaction order ID as a string.
origin_airportfb_origin_airportorigin_airportUse the airport's official IATA code of departure.
postal_codefb_postal_codepostal_codePostal code.
predicted_ltvpredicted_ltvpredicted_ltvThe predicted total value of a conversion event.
preferred_baths_rangefb_preferred_baths_rangepreferred_baths_rangeNumber of bathrooms selected in a range.
preferred_beds_rangefb_preferred_beds_rangepreferred_beds_rangeNumber of bedrooms selected in a range.
preferred_neighborhoodsfb_preferred_neighborhoodspreferred_neighborhoodsPreferred neighborhoods.
preferred_num_stopsfb_preferred_num_stopspreferred_num_stopsSpecify the number of stops the user is looking for.
preferred_price_rangefb_preferred_price_rangepreferred_price_rangeThe preferred price range for the vehicle. Min./max.: up to 2 decimal places.
preferred_star_ratingsfb_preferred_star_ratingspreferred_star_ratingsA tuple of the minimum and maximum hotel star ratings that a user applies when filtering.
pricefb_pricepriceCost and currency of the vehicle. Format the price as the cost, followed by the ISO currency code, with a space between the amount and the currency.
product_catalog_idproduct_catalog_idproduct_catalog_idProduct catalog ID.
property_typefb_property_typeproperty_typeMust be apartment, condo, house, land, manufactured, other or townhouse.
regionfb_regionregionState, district, or region of interest.
returning_arrival_datefb_returning_arrival_datereturning_arrival_dateThe date and time the return trip is completed.
returning_departure_datefb_returning_departure_datereturning_departure_dateThe date and time the return trip starts.
search_stringfb_search_stringsearch_stringUse only with events Search. A search made by a user.
state_of_vehiclefb_state_of_vehiclestate_of_vehicleVehicle condition.
suggested_destinationsfb_suggested_destinationssuggested_destinationsThe suggested destinations.
suggested_home_listingsfb_suggested_home_listingssuggested_home_listingsThe suggested real estate listings.
suggested_hotelsfb_suggested_hotelssuggested_hotelsThe suggested hotels.
suggested_jobsfb_suggested_jobssuggested_jobsThe suggested jobs.
suggested_local_service_businessesfb_suggested_local_service_businessessuggested_local_service_businessesThe suggested local service businesses.
suggested_location_based_itemsfb_suggested_location_based_itemssuggested_location_based_itemsThe suggested location-based items.
suggested_vehiclesfb_suggested_vehiclessuggested_vehiclesThe suggested vehicles.
transmissionfb_transmissiontransmissionVehicle transmission: AUTOMATIC, MANUAL, OTHER or NONE.
travel_classfb_travel_classtravel_classMust be economy, premium, business or first.
travel_endfb_travel_endtravel_endThe trip end date.
travel_startfb_travel_starttravel_startThe trip start date.
trimfb_trimtrimMaximum characters: 50.
user_bucketfb_user_bucketuser_bucketThe user's group.
value_valueToSumvalue

Required for purchase events or any events that use value optimization.

A numerical value associated with the event. It must represent a monetary value.

vinfb_vinvinChassis number.
yearfb_yearyearThe vehicle's model year in the format yyyy.
item_numberUnique identifier to distinguish events within the same order or transaction.
ad_typeThe ad type.
fb_content

A list of JSON objects containing the International Article Number (EAN), when applicable, or another product or content identifier, as well as product quantities and prices. Required: id, quantity.


Example: "[{\"id\": \"1234\", \"quantity\": 2,}, {\"id\": \"5678\", \"quantity\": 1,}]".

fb_content_idInternational Article Number (EAN), when applicable, or other content or product identifiers. For multiple product ID numbers: for example, "[\"1234\",\"5678\"]".
fb_descriptionA string description.
fb_levelThe level of a game.
fb_max_rating_valueThe maximum value of a rating scale, for example, 5 on a 5-star scale.
fb_payment_info_available1 for yes, 0 for no.
fb_registration_methodFacebook, Email, Twitter, among others.
fb_success1 for yes, 0 for no.
_valueToSumThe numeric value of the individual event to be summed in reports.
*** ### Conclusion The Meta Conversions API parameters are essential to ensure **reliable events, better user matching, and more efficient campaigns**. A correct setup directly impacts ad performance and the quality of the analyzed data. *** ### References This article was prepared based on Meta's official documentation on the Conversions API. For detailed technical information, updates, and advanced examples, see the sources below: * **Conversions API Parameters**\ 🔗 * **Custom Data Parameters**\ 🔗 📌 **Note:**\ Meta may update the parameters, validation rules, and requirements at any time. We recommend consulting the official documentation whenever there are changes in the configuration of the Conversions API or in event behavior. *** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.sprinthub.com/en/strategies/meta-business/meta-ads/conversions-api-parameters.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.