CONSIDERATIONCONVERSIONCATALOG_SALESCATALOG_SALESSALESCATALOG_SALESSALESCATALOG_SALES| Parameter | Notes |
|---|---|
ad_account_id | Required |
name | Required. |
status | Required. |
lifetime_spend_cap | Use this parameter or daily_spend_cap |
daily_spend_cap | Use this parameter or lifetime_spend_capIf using this parameter, set is_flexible_daily_budgetsTRUE |
order_line_id | Optional. |
tracking_urls | Optional. |
start_time | Required. |
end_time | Optional. |
is_flexible_daily_budgets | Set to TRUEdaily_spend_cap |
objective_type | Required. Pinterest Performance+ supports CONSIDERATIONCATALOG_SALESWEB_CONVERSIONS |
is_performance_plus | Set to TRUE |
default_ad_group_budget_in_micro_currencyis_automated_campaignCONVERSIONCONSIDERATIONCATALOG_SALESALL_PRODUCTSCATALOG_SALESnametracking_urlsstatustargeting_template_idsdefault_utm_source_enabledcustom_url_parametersbid_multiplierPINNER_LIST_INCLUDEPINNER_LIST_EXCLUDESHOPPING_RETARGETING| Parameter | Notes |
|---|---|
name | Required. |
status | Required. Default is ACTIVE |
optimization_goal_metadata | Required for CATALOG_SALES |
conversion_tag_v3_goal_metadata.conversion_event | Required for CATALOG_SALESSet one of the following:
|
conversion_tag_v3_goal_metadata(All other parameters) | Optional. |
frequency_goal_metadata | Optional. |
targeting_spec.AGE_BUCKET | Optional. For all ages, do not set any value. For 18+, set to all of the following:
|
targeting_spec.AUDIENCE_EXCLUDE | Optional. |
targeting_spec.AUDIENCE_INCLUDE | Optional. |
targeting_spec.GEO | Required. Set at least one of GEOLOCATION |
targeting_spec.LOCATION | Required. Set at least one of GEOLOCATION |
targeting_spec(all other targeting types) | Do not set any value. Not supported by Pinterest Performance+. |
tracking_urls | Optional. |
campaign_id | Required. |
billable_event | Required. |
bid_strategy_type | Required. Set to AUTOMATIC_BID |
is_creative_optimization | Optional. Use to enable Pinterest Performance+ Creative optimizations. |
budget_in_micro_currencybid_in_micro_currencyscrollup_goal_metadatabudget_typestart_timeend_timeplacement_grouppacing_delivery_typetargeting_template_idsauto_targeting_enabledCATALOG_SALESCATALOG_SALESCATALOG_SALESCATALOG_SALES| Parameter | Notes |
|---|---|
ad_group_id | Required. |
android_deep_link | Optional. |
carousel_android_deep_links | Optional. |
carousel_destination_urls | Optional. |
carousel_ios_deep_links | Optional. |
click_tracking_url | Optional. |
creative_type | Required. Set to any value except: SHOPPINGQUIZSHOWCASE |
destination_url | Optional. |
ios_deep_link | Optional. |
is_removable | Optional. |
name | Optional. |
status | Required. Default is ACTIVE |
tracking_urls | Optional. |
view_tracking_url | Optional. |
customizable_cta_type | Optional. |
pin_id | Required. |
is_pin_deletedlead_form_idgrid_click_typequiz_pin_dataALL_PRODUCTSALL_PRODUCTS| Parameter | Notes |
|---|---|
id | Required. |
ad_group_id | Required. |
is_mdl | Optional. |
status | Required. Default is ACTIVE |
tracking_url | Optional. |
catalog_product_group_id | Required. Pinterest Performance+ only supports autogenerated ALL_PRODUCTS |
creative_type | Required. Set to SHOPPING |
is_generate_background | Optional. Only supported for CATALOG_SALES |
bid_in_micro_currencyincludeddefinitionrelative_definitionparent_idslideshow_collections_titleslideshow_collections_descriptioncatalog_product_group_namecollections_hero_pin_idcollections_hero_destination_urlgrid_click_typenamefrequency_goal_metadatatracking_urlsoptimization_goal_metadatatargeting_spec:AGE_BUCKETAUDIENCE_EXCLUDEGEOLOCATIONAUDIENCE_INCLUDEAUDIENCE_INCLUDEstatusARCHIVEDis_creative_optimizationad_group_idsandroid_deep_linkcarousel_android_deep_linkscarousel_destination_urlscarousel_ios_deep_linksclick_tracking_urldestination_urlios_deep_linkis_removablenametracking_urlsview_tracking_urlcustomizable_cta_typeis_mdlstatustracking_urlcatalog_product_group_id| Field | Description |
|---|---|
performance_plus_campaign_settingsobject Optional but necessary for this use case | Container for settings that only apply to Pinterest Performance+ campaigns, and are otherwise omitted. |
performance_plus_campaign_settings.boost_prospecting_ad_group_bidboolean Optional but necessary for this use case | Set to true |
performance_plus_campaign_settings.pinner_list_exclusionsarray of strings Optional but necessary for this use case | Pass audience list ids of existing customers to exclude these from targeting so that the campaign is biased toward new customers. |
curl --request POST \ --url https://api.pinterest.com/v5/ad_accounts/123456789012/campaigns \ --header 'authorization: Bearer pina_ABCD1234...' \ --header 'content-type: application/json' \ --data' [ { "advertiser_id": "ADV_ID", "name": "Catalog sales Campaign | 2026-03-25 18:27 UTC", "status": "ACTIVE", "lifetime_spend_cap": 0, "daily_spend_cap": 20000000, "is_campaign_budget_optimization": true, "start_time": 1774463220, "is_flexible_daily_budgets": true, "is_performance_plus": true, "performance_plus_campaign_settings": { "pinner_list_exclusions": [], "boost_prospecting_ad_group_bid": true }, "objective_type": "CATALOG_SALES" } ]'
| Parameter | Description |
|---|---|
performance_plus_campaign_settingsobject Optional, but necessary for this use case | Container for settings that only apply to Pinterest Performance+ campaigns, and are otherwise omitted. |
performance_plus_campaign_settings.boost_prospecting_ad_group_bidboolean Optional, but necessary for this use case | Set to true |
performance_plus_campaign_settings.pinner_list_exclusionsarray of strings Optional, but necessary for this use case | Pass audience lists of existing customers to exclude these from targeting so that the campaign is biased toward new customers. |
feed_profile_idstring Optional, but necessary for this use case | For campaigns with a CATALOG_SALESYou can retrieve the ID by calling . |
targeting_spec.AUDIENCE_INCLUDEarray of strings, nullable Optional | Omit for NCA-focused campaigns. |
curl --request POST \ --url https://api.pinterest.com/v5/ad_accounts/123456789012/ad_groups \ --header 'authorization: Bearer pina_ABCD1234...' \ --header 'content-type: application/json' \ --data '[ { "name": "Catalog sales Ad group | 2026-03-25 18:27 UTC", "status": "ACTIVE", "budget_type": "CBO_ADGROUP", "bid_multiplier": 0, "auto_targeting_enabled": true, "placement_group": "ALL", "pacing_delivery_type": "STANDARD", "bid_strategy_type": "AUTOMATIC_BID", "feed_profile_id": "1234567890", "optimization_goal_metadata": { "frequency_goal_metadata": {} }, "targeting_spec": { "AGE_BUCKET": [], "APPTYPE": [ "web", "ipad", "web_mobile", "iphone", "android_mobile", "android_tablet" ], "DEVICE_MODEL": [], "INTERNET_SERVICE_PROVIDER": [], "AUDIENCE_EXCLUDE": [], "GENDER": [ "female", "male", "unknown" ], "INTEREST": [], "LOCALE": [], "LOCATION": [ "US" ], "TARGETING_STRATEGY": [ "CHOOSE_YOUR_OWN" ] }, "tracking_urls": {}, "customer_segment_id": "1234567890", "is_creative_optimization": "OPT_IN", "is_simplified_targeting": false, "performance_plus_campaign_settings": { "pinner_list_exclusions": [], "boost_prospecting_ad_group_bid": true }, "campaign_id": "CAMPAIGN_ID", "billable_event": "CLICKTHROUGH" } ]'
customer_segment_id0customer_segment_idAUDIENCE_INCLUDEbid_multiplierbid_multiplier0