account | DynamicAccount | Yes | - | Select Pinterest Ads account to create the ad in. |
update_type | string or SelectableOption | Yes | - | Choose whether to promote a single Pin or multiple Pins at once. Options: single or bulk. |
ad_group_id | string or SelectItem | No | - | Pinterest ad group ID to create the ad under. |
pin_id | string | No | - | ID of the existing Pin to promote. |
ad_name | string | No | - | Name of the Pinterest ad. |
ad_status | string or SelectableOption | No | {'value': 'PAUSED', 'label': 'Paused'} | Status when the ad is created. Options: ACTIVE or PAUSED. Default: PAUSED. |
creative_type | string or SelectableOption | No | - | Optional ad creative type. Omit to let Markifact detect it from the Pin’s media (image Pin: REGULAR, video Pin: VIDEO, carousel Pin: CAROUSEL). Set it explicitly only for special formats such as MAX_VIDEO, COLLECTION, or IDEA. |
destination_url | string | No | - | Optional landing page URL override for the ad click-through. Defaults to the Pin’s link. Pinterest appends its default utm_ parameters to ad URLs that have none unless the account opts out in Business Manager; parameters you include are kept. |
call_to_action | string or SelectableOption | No | - | Optional Pinterest customizable CTA type, for example LEARN_MORE, SHOP_NOW, SIGN_UP. |
lead_form_id | string | No | - | Optional Pinterest lead form ID to create a lead ad. |
click_tracking_url | string | No | - | Optional third-party click tracking URL. |
view_tracking_url | string | No | - | Optional third-party impression tracking URL. |
android_deep_link | string | No | - | Optional Android deep link URL. |
ios_deep_link | string | No | - | Optional iOS deep link URL. |
is_dynamic_cta | boolean | No | False | Let Pinterest pick the best CTA per placement and device from cta_types instead of always serving one fixed CTA. Cannot be combined with call_to_action. Default false. |
cta_types | string or array of string | No | - | CTAs Pinterest may choose between when is_dynamic_cta is true, as a JSON list or comma-separated string. At least two, from: ADD_TO_CART, BUY_NOW, CONTACT_US, EXPLORE_MORE, GET_OFFER, LEARN_MORE, ORDER_NOW, SHOP_NOW, TAKE_A_PEEK, VISIT_SITE. Pinterest also requires the campaign objective’s default CTA to be in the list (VISIT_SITE for CONSIDERATION) and names the missing one in its error. Example: [“VISIT_SITE”, “SHOP_NOW”, “LEARN_MORE”]. |
return_detailed_results | boolean | No | False | Bulk mode only. If true, returns per-row results and does not raise on partial failures. |
structured_data | array (also accepts a comma-separated string) | No | - | Use only when update_type is bulk. Required columns: pin_id, ad_group_id, ad_name. Optional columns: ad_status, creative_type, destination_url, call_to_action, is_dynamic_cta, cta_types, lead_form_id, click_tracking_url, view_tracking_url, android_deep_link, ios_deep_link. |