account | DynamicAccount | Yes | - | Select Pinterest Ads account to create the carousel Pin and ad in. |
update_type | string or SelectableOption | Yes | - | Choose whether to create a single carousel ad or multiple at once. Options: single or bulk. |
ad_group_id | string or SelectItem | No | - | Pinterest ad group ID to create the ad under. Required unless pin_only is true. |
ad_name | string | No | - | Name of the Pinterest ad. Required unless pin_only is true. |
ad_status | string or SelectableOption | No | {'value': 'PAUSED', 'label': 'Paused'} | Status when the ad is created. Options: ACTIVE or PAUSED. Default: PAUSED. |
cards | array of object or string | No | - | Single mode only. JSON list of 2 to 5 carousel cards. Each card: image_url (required; direct URL, Google Drive share link set to ‘Anyone with the link’, or Markifact uploaded image), and optional title, description, and link (per-card destination URL). Example: [{“image_url”: “https://example.com/a.jpg”, “title”: “Card A”, “link”: “https://example.com/a”}, {“image_url”: “https://example.com/b.jpg”}] |
pin_title | string | No | - | Title for the carousel Pin. Up to 100 characters. |
pin_description | string | No | - | Description for the carousel Pin. Up to 800 characters. |
destination_url | string | No | - | Fallback landing page URL for the Pin and ad. Per-card links override it. |
board_id | string or SelectItem | No | - | Board ID to save the Pin to. Required only when ad_only_pin is false. |
ad_only_pin | boolean | No | True | Create the Pin as ad-only so it does not appear organically. Default true. |
pin_only | boolean | No | False | Create only the Pinterest carousel Pin and skip ad creation. Default false. |
call_to_action | string or SelectableOption | No | - | Optional Pinterest customizable CTA type, for example LEARN_MORE, SHOP_NOW, SIGN_UP. |
click_tracking_url | string | No | - | Optional third-party click tracking URL. |
view_tracking_url | string | No | - | Optional third-party impression tracking URL. |
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. Each row is one carousel ad. Required columns: card_1_image_url, card_2_image_url, destination_url, pin_title or pin_description, plus ad_group_id and ad_name unless pin_only is true. Optional columns: card_3_image_url to card_5_image_url, card_N_title, card_N_description, card_N_link, board_id, ad_only_pin, pin_only, ad_status, call_to_action, click_tracking_url, view_tracking_url. If any card_N field is set, that card’s card_N_image_url is required. |