# Pinterest Ads

Source: https://pilot.braike.com/en/docs/regies/pinterest

The 91 tools Pilot MCP serves for Pinterest Ads: 60 read-only, and 31 that write with the €29 plan, taken from the server.

Pilot MCP serves **60 read-only tools** for Pinterest Ads, on every plan. With the €29 plan, it also serves **24** that create or change and **7** that delete. Their names start with `pinterest_`.

<Callout title="What each entry shows">
The name, description and parameters come from the list the server serves to your assistant (`tools/list`). Descriptions are in English: this is the text your assistant receives. Your assistant never fills in platform credentials: Pilot adds them on each call.
</Callout>

<Callout title="Writing and deleting">
Write tools are only served with the €29 plan: your assistant creates, changes, pauses and deletes there, with no access level to pick when you connect. On the free plan, it does not see them. A change that sets an object to deleted or archived counts as a deletion, and a deletion targets one object at a time. Changes apply directly on the ad platform: Pilot reads the object from the platform before and after the write, and logs it in your workspace. See [Read and write](/en/docs/limites-et-forfaits#ecritures).
</Callout>

## Tool families [#familles]

| Family | Tools |
| --- | ---: |
| [Other tools](#autres) | 60 |
| [Create and change (€29)](#modification) | 24 |
| [Delete (€29)](#suppression) | 7 |

## Other tools [#autres]

### `pinterest_ad_accounts_analytics` [#pinterest_ad_accounts_analytics]

**Pinterest Ads: Ad Accounts Analytics** · read-only · idempotent

Get analytics metrics for an ad account over a date range. Returns spend, impressions, clicks, CTR, CPC, CPM, conversions and more. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |
| `start_date` | `string` | yes | Start date in YYYY-MM-DD format. |
| `end_date` | `string` | yes | End date in YYYY-MM-DD format. |
| `columns` | `string[]` | yes | Metrics to return. Example: \["SPEND\_IN\_DOLLAR","IMPRESSION\_1","CLICK\_1","CTR","CPC\_IN\_MICRO\_DOLLAR"\]. |
| `granularity` | `string` | no | Aggregation granularity (default: TOTAL). Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |
| `click_window_days` | `integer` | no | Attribution click window (1,7,14,30,60). |
| `engagement_window_days` | `integer` | no | Attribution engagement window. |
| `view_window_days` | `integer` | no | Attribution view-through window. |
| `conversion_report_time` | `string` | no | Values: `"TIME_OF_AD_ACTION"`, `"TIME_OF_CONVERSION"`. |

### `pinterest_ad_accounts_get` [#pinterest_ad_accounts_get]

**Pinterest Ads: Ad Accounts Get** · read-only · idempotent

Get details for a specific ad account by its ID. DEPENDENCY: access\_token + ad\_account\_id (from ad\_accounts\_list).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |

### `pinterest_ad_accounts_get_report` [#pinterest_ad_accounts_get_report]

**Pinterest Ads: Ad Accounts Get Report** · read-only · idempotent

Poll an async report previously requested via ad\_accounts\_create\_report. DEPENDENCY: access\_token + ad\_account\_id + token from ad\_accounts\_create\_report.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |
| `token` | `string` | yes | Report request token from ad\_accounts\_create\_report. |

### `pinterest_ad_accounts_get_templates` [#pinterest_ad_accounts_get_templates]

**Pinterest Ads: Ad Accounts Get Templates** · read-only · idempotent

List saved report templates for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |
| `page_size` | `integer` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `bookmark` | `string` | no | Pagination cursor. |

### `pinterest_ad_accounts_list` [#pinterest_ad_accounts_list]

**Pinterest Ads: Ad Accounts List** · read-only · idempotent

List all ad accounts accessible by the authenticated user. Includes accounts they own and shared accounts. DEPENDENCY: access\_token. Call this first to obtain ad\_account\_id values.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `include_shared_accounts` | `boolean` | no | Include ad accounts shared with the user (default: true). |
| `bookmark` | `string` | no | Pagination cursor from previous response. |
| `page_size` | `integer` | no | Number of results per page (max 250). |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_ad_accounts_targeting_analytics` [#pinterest_ad_accounts_targeting_analytics]

**Pinterest Ads: Ad Accounts Targeting Analytics** · read-only · idempotent

Get targeting analytics (by age, gender, interest, etc.) for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `targeting_types` | `string[]` | yes | e.g. \["GENDER","AGE\_BUCKET","GEO","INTEREST","KEYWORD","AUDIENCE"\]. |
| `columns` | `string[]` | yes | Metrics to return. |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |

### `pinterest_ad_accounts_terms_of_service` [#pinterest_ad_accounts_terms_of_service]

**Pinterest Ads: Ad Accounts Terms of Service** · read-only · idempotent

Get terms of service for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |
| `include_html` | `boolean` | no | Include HTML content. |
| `tos_type` | `string` | no | Terms type filter. |

### `pinterest_ad_groups_analytics` [#pinterest_ad_groups_analytics]

**Pinterest Ads: Ad Groups Analytics** · read-only · idempotent

Get performance analytics for ad groups. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `ad_group_ids` | `string[]` | no |   |
| `columns` | `string[]` | yes |   |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |
| `click_window_days` | `integer` | no |   |
| `engagement_window_days` | `integer` | no |   |
| `view_window_days` | `integer` | no |   |
| `conversion_report_time` | `string` | no | Values: `"TIME_OF_AD_ACTION"`, `"TIME_OF_CONVERSION"`. |

### `pinterest_ad_groups_audience_sizing` [#pinterest_ad_groups_audience_sizing]

**Pinterest Ads: Ad Groups Audience Sizing** · read-only · idempotent

Estimate the audience size for a targeting spec before creating an ad group. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `targeting_spec` | `object` | no | Targeting options to estimate audience for. |
| `placement_group` | `string` | no | Values: `"ALL"`, `"SEARCH"`, `"BROWSE"`, `"OTHER"`. |

### `pinterest_ad_groups_bid_floor` [#pinterest_ad_groups_bid_floor]

**Pinterest Ads: Ad Groups Bid Floor** · read-only · idempotent

Get the minimum bid floor for an ad group configuration. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `bid_floor_specs` | `object[]` | no | Array of bid floor spec objects. |

### `pinterest_ad_groups_get` [#pinterest_ad_groups_get]

**Pinterest Ads: Ad Groups Get** · read-only · idempotent

Get a single ad group by ID. DEPENDENCY: access\_token + ad\_account\_id + ad\_group\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `ad_group_id` | `string` | yes | Ad group unique identifier. |
| `translate_interests_to_names` | `boolean` | no |   |

### `pinterest_ad_groups_list` [#pinterest_ad_groups_list]

**Pinterest Ads: Ad Groups List** · read-only · idempotent

List ad groups for an ad account. Optionally filter by campaign or status. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaign_ids` | `string[]` | no | Filter by campaign IDs. |
| `ad_group_ids` | `string[]` | no | Filter by specific ad group IDs. |
| `entity_statuses` | `string[]` | no | Values: `"ACTIVE"`, `"PAUSED"`, `"ARCHIVED"`. |
| `page_size` | `integer` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `bookmark` | `string` | no |   |
| `translate_interests_to_names` | `boolean` | no | Return human-readable interest names. |

### `pinterest_ad_groups_targeting_analytics` [#pinterest_ad_groups_targeting_analytics]

**Pinterest Ads: Ad Groups Targeting Analytics** · read-only · idempotent

Get targeting breakdown analytics for ad groups. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `ad_group_ids` | `string[]` | no |   |
| `targeting_types` | `string[]` | yes |   |
| `columns` | `string[]` | yes |   |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |

### `pinterest_ads_analytics` [#pinterest_ads_analytics]

**Pinterest Ads: Ads Analytics** · read-only · idempotent

Get performance analytics for individual ads. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `ad_ids` | `string[]` | no |   |
| `columns` | `string[]` | yes |   |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |
| `click_window_days` | `integer` | no |   |
| `engagement_window_days` | `integer` | no |   |
| `view_window_days` | `integer` | no |   |
| `conversion_report_time` | `string` | no | Values: `"TIME_OF_AD_ACTION"`, `"TIME_OF_CONVERSION"`. |

### `pinterest_ads_get` [#pinterest_ads_get]

**Pinterest Ads: Ads Get** · read-only · idempotent

Get a single ad by ID. DEPENDENCY: access\_token + ad\_account\_id + ad\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `ad_id` | `string` | yes | Ad unique identifier. |

### `pinterest_ads_list` [#pinterest_ads_list]

**Pinterest Ads: Ads List** · read-only · idempotent

List ads for an ad account. Optionally filter by campaign, ad group, or status. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaign_ids` | `string[]` | no |   |
| `ad_group_ids` | `string[]` | no |   |
| `ad_ids` | `string[]` | no |   |
| `entity_statuses` | `string[]` | no | Values: `"ACTIVE"`, `"PAUSED"`, `"ARCHIVED"`. |
| `page_size` | `integer` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `bookmark` | `string` | no |   |

### `pinterest_ads_preview` [#pinterest_ads_preview]

**Pinterest Ads: Ads Preview** · read-only · idempotent

Generate a preview URL for an ad creative before publishing. Returns a URL to view the ad in Pinterest preview mode. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `creative_type` | `string` | yes | Values: `"REGULAR"`, `"VIDEO"`, `"SHOPPING"`, `"CAROUSEL"`, `"MAX_VIDEO"`, `"SHOP_THE_PIN"`, `"COLLECTION"`, `"IDEA"`. |
| `pin_id` | `string` | no | Existing pin to use as creative. |
| `image_url` | `string` | no | Image URL for the creative. |
| `title` | `string` | no |   |
| `description` | `string` | no |   |

### `pinterest_ads_targeting_analytics` [#pinterest_ads_targeting_analytics]

**Pinterest Ads: Ads Targeting Analytics** · read-only · idempotent

Get targeting breakdown analytics for individual ads. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `ad_ids` | `string[]` | no |   |
| `targeting_types` | `string[]` | yes |   |
| `columns` | `string[]` | yes |   |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |

### `pinterest_audience_insights_audiences` [#pinterest_audience_insights_audiences]

**Pinterest Ads: Audience Insights Audiences** · read-only · idempotent

List audiences eligible for insights in an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `page_size` | `integer` | no |   |
| `bookmark` | `string` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `entities` | `string` | no | Values: `"AUDIENCE"`, `"AUDIENCE_LIST"`. |

### `pinterest_audience_insights_get` [#pinterest_audience_insights_get]

**Pinterest Ads: Audience Insights Get** · read-only · idempotent

Get audience insights for an ad account (reach, demographics, interests breakdown). DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `audience_insight_type` | `string` | yes | Values: `"YOUR_TOTAL_AUDIENCE"`, `"YOUR_ENGAGED_AUDIENCE"`, `"PINTEREST_TOTAL_AUDIENCE"`. |

### `pinterest_audiences_get` [#pinterest_audiences_get]

**Pinterest Ads: Audiences Get** · read-only · idempotent

Get a single audience by ID. DEPENDENCY: access\_token + ad\_account\_id + audience\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `audience_id` | `string` | yes | Audience unique identifier. |

### `pinterest_audiences_list` [#pinterest_audiences_list]

**Pinterest Ads: Audiences List** · read-only · idempotent

List audiences for an ad account (custom audiences, actalike, etc.). DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `bookmark` | `string` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `page_size` | `integer` | no |   |
| `ownership_type` | `string` | no | Filter by ownership. Values: `"OWNED"`, `"SHARED"`. |

### `pinterest_bulk_download` [#pinterest_bulk_download]

**Pinterest Ads: Bulk Download** · read-only · creates an object on each call

Request a bulk download of campaigns, ad groups, ads, keywords, etc. Returns a bulk\_request\_id for polling. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `entity_types` | `string[]` | yes | Entity types to download. Values: `"CAMPAIGN"`, `"AD_GROUP"`, `"PRODUCT_GROUP"`, `"AD"`, `"KEYWORD"`, `"TARGETING_TEMPLATE"`, `"PRODUCT_GROUP_PROMOTION"`. |
| `entity_ids` | `string[]` | no |   |
| `updated_since` | `string` | no | Unix timestamp - only return items updated after this time. |
| `start_time` | `string` | no | Unix timestamp for date range start. |
| `end_time` | `string` | no | Unix timestamp for date range end. |
| `status_filter` | `string` | no | Values: `"ACTIVE"`, `"PAUSED"`, `"ARCHIVED"`, `"DRAFT"`, `"DELETED_DRAFT"`. |
| `output_format` | `string` | no | Values: `"JSON"`, `"CSV"`. |

### `pinterest_bulk_get_request` [#pinterest_bulk_get_request]

**Pinterest Ads: Bulk Get Request** · read-only · idempotent

Poll the status and download URL of a bulk request. DEPENDENCY: access\_token + ad\_account\_id + bulk\_request\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `bulk_request_id` | `string` | yes | Bulk request ID from bulk\_download. |
| `include_details` | `boolean` | no |   |

### `pinterest_campaigns_analytics` [#pinterest_campaigns_analytics]

**Pinterest Ads: Campaigns Analytics** · read-only · idempotent

Get analytics metrics for campaigns (spend, impressions, clicks, etc.). DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `campaign_ids` | `string[]` | no | Filter by specific campaign IDs. |
| `columns` | `string[]` | yes | Metrics columns e.g. \["SPEND\_IN\_DOLLAR","IMPRESSION\_1","CLICK\_1","CTR","CPC\_IN\_MICRO\_DOLLAR"\]. |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |
| `click_window_days` | `integer` | no |   |
| `engagement_window_days` | `integer` | no |   |
| `view_window_days` | `integer` | no |   |
| `conversion_report_time` | `string` | no | Values: `"TIME_OF_AD_ACTION"`, `"TIME_OF_CONVERSION"`. |

### `pinterest_campaigns_get` [#pinterest_campaigns_get]

**Pinterest Ads: Campaigns Get** · read-only · idempotent

Get a single campaign by ID. DEPENDENCY: access\_token + ad\_account\_id + campaign\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaign_id` | `string` | yes | Campaign unique identifier. |

### `pinterest_campaigns_list` [#pinterest_campaigns_list]

**Pinterest Ads: Campaigns List** · read-only · idempotent

List campaigns for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaign_ids` | `string[]` | no | Filter by specific campaign IDs (max 100). |
| `entity_statuses` | `string[]` | no | Filter by status. Values: `"ACTIVE"`, `"PAUSED"`, `"ARCHIVED"`, `"DRAFT"`, `"DELETED_DRAFT"`. |
| `page_size` | `integer` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `bookmark` | `string` | no | Pagination cursor. |

### `pinterest_campaigns_pin_analytics` [#pinterest_campaigns_pin_analytics]

**Pinterest Ads: Campaigns Pin Analytics** · read-only · idempotent

Get pin-level analytics across campaigns for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `columns` | `string[]` | yes |   |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |

### `pinterest_campaigns_targeting_analytics` [#pinterest_campaigns_targeting_analytics]

**Pinterest Ads: Campaigns Targeting Analytics** · read-only · idempotent

Get targeting breakdown analytics for campaigns. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `campaign_ids` | `string[]` | no |   |
| `targeting_types` | `string[]` | yes | e.g. \["GENDER","AGE\_BUCKET","GEO","INTEREST","KEYWORD","AUDIENCE"\]. |
| `columns` | `string[]` | yes |   |
| `granularity` | `string` | no | Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |

### `pinterest_catalog_feeds_get` [#pinterest_catalog_feeds_get]

**Pinterest Ads: Catalog Feeds Get** · read-only · idempotent

Get details of a specific catalog feed. DEPENDENCY: access\_token + feed\_id (from catalog\_feeds\_list).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `feed_id` | `string` | yes | Feed unique identifier. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_feeds_list` [#pinterest_catalog_feeds_list]

**Pinterest Ads: Catalog Feeds List** · read-only · idempotent

List all feeds for a catalog. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `catalog_id` | `string` | no | Filter by catalog ID. |
| `ad_account_id` | `string` | no |   |
| `bookmark` | `string` | no |   |
| `page_size` | `integer` | no |   |

### `pinterest_catalog_feeds_processing_results` [#pinterest_catalog_feeds_processing_results]

**Pinterest Ads: Catalog Feeds Processing Results** · read-only · idempotent

Get the processing results for a catalog feed (status, item counts, errors). DEPENDENCY: access\_token + feed\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `feed_id` | `string` | yes | Feed unique identifier. |
| `ad_account_id` | `string` | no |   |
| `bookmark` | `string` | no |   |
| `page_size` | `integer` | no |   |

### `pinterest_catalog_items_batch_get` [#pinterest_catalog_items_batch_get]

**Pinterest Ads: Catalog Items Batch Get** · read-only · idempotent

Poll the status of a catalog items batch operation. DEPENDENCY: access\_token + batch\_id (from catalog\_items\_batch\_upsert).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `batch_id` | `string` | yes | Batch operation ID. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_items_get` [#pinterest_catalog_items_get]

**Pinterest Ads: Catalog Items Get** · read-only · idempotent

Get catalog items by item IDs. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `country` | `string` | yes | ISO 3166-1 alpha-2 country code. |
| `language` | `string` | yes | ISO 639-1 language code. |
| `item_ids` | `string[]` | yes | Product item IDs. |
| `ad_account_id` | `string` | no |   |
| `catalog_id` | `string` | no |   |

### `pinterest_catalog_product_groups_get` [#pinterest_catalog_product_groups_get]

**Pinterest Ads: Catalog Product Groups Get** · read-only · idempotent

Get a specific product group by ID. DEPENDENCY: access\_token + product\_group\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `product_group_id` | `string` | yes | Product group unique identifier. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_product_groups_list` [#pinterest_catalog_product_groups_list]

**Pinterest Ads: Catalog Product Groups List** · read-only · idempotent

List product groups for a catalog or feed. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `feed_id` | `string` | no | Filter by feed ID. |
| `catalog_id` | `string` | no | Filter by catalog ID. |
| `bookmark` | `string` | no |   |
| `page_size` | `integer` | no |   |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_product_groups_product_counts` [#pinterest_catalog_product_groups_product_counts]

**Pinterest Ads: Catalog Product Groups Product Counts** · read-only · idempotent

Get the product count for a product group. DEPENDENCY: access\_token + product\_group\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `product_group_id` | `string` | yes | Product group unique identifier. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalogs_available_filter_values` [#pinterest_catalogs_available_filter_values]

**Pinterest Ads: Catalogs Available Filter Values** · read-only · idempotent

Get available values for catalog feed filter attributes. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `filter_type` | `string` | yes | Filter attribute type (e.g. "gender"). |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalogs_list` [#pinterest_catalogs_list]

**Pinterest Ads: Catalogs List** · read-only · idempotent

List all catalogs accessible by the authenticated user. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `bookmark` | `string` | no |   |
| `page_size` | `integer` | no |   |
| `ad_account_id` | `string` | no | Filter by ad account. |

### `pinterest_conversion_tags_get` [#pinterest_conversion_tags_get]

**Pinterest Ads: Conversion Tags Get** · read-only · idempotent

Get a specific conversion tag by ID. DEPENDENCY: access\_token + ad\_account\_id + conversion\_tag\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `conversion_tag_id` | `string` | yes | Conversion tag unique identifier. |

### `pinterest_conversion_tags_list` [#pinterest_conversion_tags_list]

**Pinterest Ads: Conversion Tags List** · read-only · idempotent

List all conversion tags for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `filter_deleted` | `boolean` | no | Exclude deleted tags. |

### `pinterest_customer_lists_get` [#pinterest_customer_lists_get]

**Pinterest Ads: Customer Lists Get** · read-only · idempotent

Get a specific customer list by ID. DEPENDENCY: access\_token + ad\_account\_id + customer\_list\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `customer_list_id` | `string` | yes | Customer list unique identifier. |

### `pinterest_customer_lists_list` [#pinterest_customer_lists_list]

**Pinterest Ads: Customer Lists List** · read-only · idempotent

List customer lists for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `page_size` | `integer` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `bookmark` | `string` | no |   |

### `pinterest_keywords_list` [#pinterest_keywords_list]

**Pinterest Ads: Keywords List** · read-only · idempotent

List keywords for an ad account. Can filter by campaign or ad group. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaign_id` | `string` | no | Filter by campaign. |
| `ad_group_id` | `string` | no | Filter by ad group. |
| `match_types` | `string[]` | no | Filter by match type. Values: `"BROAD"`, `"PHRASE"`, `"EXACT"`, `"COMPOUND"`. |
| `page_size` | `integer` | no |   |
| `bookmark` | `string` | no |   |

### `pinterest_keywords_metrics` [#pinterest_keywords_metrics]

**Pinterest Ads: Keywords Metrics** · read-only · idempotent

Get search volume metrics for keywords. Helps with keyword research. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `keywords` | `string[]` | yes | Keyword strings to get metrics for (max 2000). |

### `pinterest_keywords_trending` [#pinterest_keywords_trending]

**Pinterest Ads: Keywords Trending** · read-only · idempotent

Get trending keywords for a region and trend type. Requires an OAuth2 access\_token with the user\_accounts:read scope. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `region` | `string` | yes | Region code e.g. "US", "CA", "GB", "AU", "IE", "IN", "NZ". |
| `trend_type` | `string` | yes | Trend type. Values: `"growing"`, `"monthly"`, `"yearly"`, `"seasonal"`. |
| `interests` | `string[]` | no | Filter by interest categories. |
| `genders` | `string[]` | no | Values: `"FEMALE"`, `"MALE"`, `"UNKNOWN"`. |
| `ages` | `string[]` | no |   |
| `normalize_against_group` | `boolean` | no | Normalize data within the group. |
| `limit` | `integer` | no | Number of results (max 50). |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_lead_ads_subscriptions_get` [#pinterest_lead_ads_subscriptions_get]

**Pinterest Ads: Lead Ads Subscriptions Get** · read-only · idempotent

Get ONE lead ad subscription by subscription\_id. DEPENDENCY: access\_token + ad\_account\_id + subscription\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `subscription_id` | `string` | yes | Lead ads subscription unique identifier. |

### `pinterest_lead_ads_subscriptions_list` [#pinterest_lead_ads_subscriptions_list]

**Pinterest Ads: Lead Ads Subscriptions List** · read-only · idempotent

List lead ad subscriptions for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `page_size` | `integer` | no |   |
| `bookmark` | `string` | no |   |

### `pinterest_lead_forms_get` [#pinterest_lead_forms_get]

**Pinterest Ads: Lead Forms Get** · read-only · idempotent

Get a specific lead form by ID. DEPENDENCY: access\_token + ad\_account\_id + lead\_form\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `lead_form_id` | `string` | yes | Lead form unique identifier. |

### `pinterest_lead_forms_list` [#pinterest_lead_forms_list]

**Pinterest Ads: Lead Forms List** · read-only · idempotent

List lead forms for an ad account. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `page_size` | `integer` | no |   |
| `order` | `string` | no | Values: `"ASCENDING"`, `"DESCENDING"`. |
| `bookmark` | `string` | no |   |

### `pinterest_resources_ad_account_countries` [#pinterest_resources_ad_account_countries]

**Pinterest Ads: Resources Ad Account Countries** · read-only · idempotent

Get the list of countries supported for ad accounts. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_resources_delivery_metrics` [#pinterest_resources_delivery_metrics]

**Pinterest Ads: Resources Delivery Metrics** · read-only · idempotent

Get available delivery metrics and their definitions. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `report_type` | `string` | no | Filter by report type. Values: `"SYNC"`, `"ASYNC"`. |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_resources_interest_details` [#pinterest_resources_interest_details]

**Pinterest Ads: Resources Interest Details** · read-only · idempotent

Get details about a specific interest category by ID. DEPENDENCY: access\_token + interest\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `interest_id` | `string` | yes | Interest category unique identifier. |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_resources_targeting_options` [#pinterest_resources_targeting_options]

**Pinterest Ads: Resources Targeting Options** · read-only · idempotent

Get available targeting options by type (e.g. AGE\_BUCKET, GENDER, GEO, INTEREST, KEYWORD, LOCALE, etc.). DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `targeting_type` | `string` | yes | Values: `"AGE_BUCKET"`, `"APPTYPE"`, `"AUDIENCE_CATEGORY"`, `"AUDIENCE_LIST"`, `"GENDER"`, `"GEO"`, `"INTEREST"`, `"KEYWORD"`, `"LANGUAGE"`, `"LOCALE"`, `"LOCATION"`, `"SHOPPING_RETARGETING"`, `"TARGETING_STRATEGY"`. |
| `client_id` | `string` | no |   |
| `oauth_signature` | `string` | no |   |
| `timestamp` | `string` | no |   |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_terms_related` [#pinterest_terms_related]

**Pinterest Ads: Terms Related** · read-only · idempotent

Get terms related to a query (useful for keyword research). DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `terms` | `string[]` | yes | Seed terms (max 4). |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_terms_suggested` [#pinterest_terms_suggested]

**Pinterest Ads: Terms Suggested** · read-only · idempotent

Get suggested terms based on a query. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `term` | `string` | yes | Seed term. |
| `limit` | `integer` | no | Number of suggestions (max 10). |
| `account_id` | `string` | no | Pinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |

### `pinterest_user_account_analytics` [#pinterest_user_account_analytics]

**Pinterest Ads: User Account Analytics** · read-only · idempotent

Get analytics for the authenticated user's organic pins (impressions, saves, clicks). DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `from_claimed_content` | `string` | no | Values: `"OTHER"`, `"CLAIMED"`, `"BOTH"`. |
| `pin_format` | `string` | no | Values: `"ALL"`, `"PRODUCT"`, `"REGULAR"`, `"VIDEO"`. |
| `app_types` | `string` | no | Values: `"ALL"`, `"MOBILE"`, `"TABLET"`, `"WEB"`. |
| `content_type` | `string` | no | Values: `"ALL"`, `"BOUGHT"`, `"CREATED"`, `"SAVED"`. |
| `source` | `string` | no | Values: `"ALL"`, `"YOUR_PINS"`, `"OTHER_PINS"`. |
| `metric_types` | `string[]` | no | Values: `"ENGAGEMENT"`, `"ENGAGEMENT_RATE"`, `"IMPRESSION"`, `"OUTBOUND_CLICK"`, `"OUTBOUND_CLICK_RATE"`, `"PIN_CLICK"`, `"PIN_CLICK_RATE"`, `"SAVE"`, `"SAVE_RATE"`. |
| `split_field` | `string` | no | Values: `"NO_SPLIT"`, `"APP_TYPE"`, `"OWNED_CONTENT"`, `"SOURCE"`, `"PIN_FORMAT"`. |
| `ad_account_id` | `string` | no |   |

### `pinterest_user_account_get` [#pinterest_user_account_get]

**Pinterest Ads: User Account Get** · read-only · idempotent

Get the authenticated user's Pinterest profile (name, bio, follower count, etc.). DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | no | Optional: view as this ad account. |

### `pinterest_user_account_top_pins` [#pinterest_user_account_top_pins]

**Pinterest Ads: User Account Top Pins** · read-only · idempotent

Get the user's top performing pins over the last 90 days. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `sort_by` | `string` | yes | Values: `"ENGAGEMENT"`, `"IMPRESSION"`, `"OUTBOUND_CLICK"`, `"PIN_CLICK"`, `"SAVE"`. |
| `from_claimed_content` | `string` | no | Values: `"OTHER"`, `"CLAIMED"`, `"BOTH"`. |
| `pin_format` | `string` | no | Values: `"ALL"`, `"PRODUCT"`, `"REGULAR"`, `"VIDEO"`. |
| `app_types` | `string` | no | Values: `"ALL"`, `"MOBILE"`, `"TABLET"`, `"WEB"`. |
| `content_type` | `string` | no | Values: `"ALL"`, `"BOUGHT"`, `"CREATED"`, `"SAVED"`. |
| `source` | `string` | no | Values: `"ALL"`, `"YOUR_PINS"`, `"OTHER_PINS"`. |
| `num_of_pins` | `integer` | no | Number of top pins (default 10, max 25). |
| `created_in_last_n_days` | `integer` | no | Days back to look (max 90). |
| `ad_account_id` | `string` | no |   |

### `pinterest_user_account_top_video_pins` [#pinterest_user_account_top_video_pins]

**Pinterest Ads: User Account Top Video Pins** · read-only · idempotent

Get the user's top performing video pins over the last 90 days. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `sort_by` | `string` | yes | Values: `"IMPRESSION"`, `"SAVE"`, `"OUTBOUND_CLICK"`, `"VIDEO_MRC_VIEW"`, `"VIDEO_AVG_WATCH_TIME"`. |
| `from_claimed_content` | `string` | no | Values: `"OTHER"`, `"CLAIMED"`, `"BOTH"`. |
| `pin_format` | `string` | no | Values: `"ALL"`, `"PRODUCT"`, `"REGULAR"`, `"VIDEO"`. |
| `app_types` | `string` | no | Values: `"ALL"`, `"MOBILE"`, `"TABLET"`, `"WEB"`. |
| `content_type` | `string` | no | Values: `"ALL"`, `"BOUGHT"`, `"CREATED"`, `"SAVED"`. |
| `source` | `string` | no | Values: `"ALL"`, `"YOUR_PINS"`, `"OTHER_PINS"`. |
| `num_of_pins` | `integer` | no |   |
| `created_in_last_n_days` | `integer` | no |   |
| `ad_account_id` | `string` | no |   |

## Create and change (€29) [#modification]

Served with the €29 plan.

### `pinterest_ad_accounts_create_report` [#pinterest_ad_accounts_create_report]

**Pinterest Ads: Ad Accounts Create Report** · create or change, €29 plan · creates an object on each call

Request an asynchronous report for an ad account (returns a token for polling). DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |
| `start_date` | `string` | yes | Start date YYYY-MM-DD. |
| `end_date` | `string` | yes | End date YYYY-MM-DD. |
| `granularity` | `string` | no | Aggregation granularity (default: TOTAL). Values: `"TOTAL"`, `"DAY"`, `"HOUR"`, `"WEEK"`, `"MONTH"`. |
| `columns` | `string[]` | yes | Metrics to include. |
| `level` | `string` | yes | Report entity level. Values: `"CAMPAIGN"`, `"AD_GROUP"`, `"AD"`, `"KEYWORD"`, `"PRODUCT_GROUP"`, `"PRODUCT_GROUP_AND_KEYWORD"`. |
| `report_format` | `string` | no | Output format. Values: `"JSON"`, `"CSV"`. |
| `filters` | `any[]` | no | Optional filter objects. |

### `pinterest_ad_groups_create` [#pinterest_ad_groups_create]

**Pinterest Ads: Ad Groups Create** · create or change, €29 plan · creates an object on each call

Create one or more ad groups within a campaign. Pinterest has no DELETE for ad groups: to delete one, archive it with ad\_groups\_update (status ARCHIVED, one at a time, admin only); to stop it, use status PAUSED. DEPENDENCY: access\_token + ad\_account\_id + campaign\_id (from campaigns\_list).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `ad_groups` | `object[]` | yes | Array of ad group objects to create. |

### `pinterest_ad_groups_update` [#pinterest_ad_groups_update]

**Pinterest Ads: Ad Groups Update** · create or change, €29 plan · creates an object on each call

Update one or more existing ad groups. DEPENDENCY: access\_token + ad\_account\_id + ad\_group\_id(s).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `ad_groups` | `object[]` | yes | Array of ad group update objects (must include id). |

### `pinterest_ads_create` [#pinterest_ads_create]

**Pinterest Ads: Ads Create** · create or change, €29 plan · creates an object on each call

Create one or more ads within ad groups. Pinterest has no DELETE for ads: to delete one, archive it with ads\_update (status ARCHIVED, one at a time, admin only); to stop it, use status PAUSED. DEPENDENCY: access\_token + ad\_account\_id + ad\_group\_id (from ad\_groups\_list).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `ads` | `object[]` | yes | Array of ad creation objects. |

### `pinterest_ads_update` [#pinterest_ads_update]

**Pinterest Ads: Ads Update** · create or change, €29 plan · creates an object on each call

Update one or more existing ads. DEPENDENCY: access\_token + ad\_account\_id + ad\_id(s).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `ads` | `object[]` | yes | Array of ad update objects (must include id). |

### `pinterest_audiences_create` [#pinterest_audiences_create]

**Pinterest Ads: Audiences Create** · create or change, €29 plan · creates an object on each call

Create a new audience for targeting. Supports CUSTOMER\_LIST, VISITOR, ENGAGEMENT, ACTALIKE, and PERSONA audience types. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `name` | `string` | yes | Audience name. |
| `type` | `string` | yes | Values: `"CUSTOMER_LIST"`, `"VISITOR"`, `"ENGAGEMENT"`, `"ACTALIKE"`, `"PERSONA"`. |
| `rule` | `object` | yes | Audience rule definition (depends on audience type). |
| `description` | `string` | no |   |

### `pinterest_audiences_update` [#pinterest_audiences_update]

**Pinterest Ads: Audiences Update** · create or change, €29 plan · creates an object on each call

Update an existing audience name, description, or rule. To delete an audience, use audiences\_delete. DEPENDENCY: access\_token + ad\_account\_id + audience\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `audience_id` | `string` | yes | Audience unique identifier. |
| `name` | `string` | no |   |
| `description` | `string` | no |   |
| `rule` | `object` | no |   |
| `operation_type` | `string` | no | Operation to perform: UPDATE only (to delete, use audiences\_delete). Values: `"UPDATE"`. |

### `pinterest_campaigns_create` [#pinterest_campaigns_create]

**Pinterest Ads: Campaigns Create** · create or change, €29 plan · creates an object on each call

Create one or more campaigns for an ad account. Returns the created campaign objects. Pinterest has no DELETE for campaigns: to delete one, archive it with campaigns\_update (status ARCHIVED, one at a time, admin only); to stop it, use status PAUSED. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaigns` | `object[]` | yes | Array of campaign objects to create. |

### `pinterest_campaigns_update` [#pinterest_campaigns_update]

**Pinterest Ads: Campaigns Update** · create or change, €29 plan · creates an object on each call

Update one or more existing campaigns. DEPENDENCY: access\_token + ad\_account\_id + campaign\_id(s).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaigns` | `object[]` | yes | Array of campaign objects to update (must include id). |

### `pinterest_catalog_feeds_create` [#pinterest_catalog_feeds_create]

**Pinterest Ads: Catalog Feeds Create** · create or change, €29 plan · creates an object on each call

Create a new catalog feed with a URL to your product data. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | yes | Feed name. |
| `format` | `string` | yes | Feed file format. Values: `"TSV"`, `"CSV"`, `"XML"`. |
| `location` | `string` | yes | URL of the feed file (e.g. https://example.com/feed.csv). |
| `default_currency` | `string` | yes | ISO 4217 currency code (e.g. USD). |
| `catalog_id` | `string` | no |   |
| `ad_account_id` | `string` | no |   |
| `default_locale` | `string` | no | BCP-47 locale (e.g. en-US). |
| `default_country` | `string` | no | ISO 3166-1 alpha-2 country code. |
| `preferred_processing_schedule` | `object` | no |   |

### `pinterest_catalog_feeds_ingest` [#pinterest_catalog_feeds_ingest]

**Pinterest Ads: Catalog Feeds Ingest** · create or change, €29 plan · creates an object on each call

Manually trigger an ingestion (re-processing) of a catalog feed. DEPENDENCY: access\_token + feed\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `feed_id` | `string` | yes | Feed unique identifier. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_feeds_update` [#pinterest_catalog_feeds_update]

**Pinterest Ads: Catalog Feeds Update** · create or change, €29 plan · creates an object on each call

Update a catalog feed URL, name, format, or schedule. DEPENDENCY: access\_token + feed\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `feed_id` | `string` | yes | Feed unique identifier. |
| `ad_account_id` | `string` | no |   |
| `name` | `string` | no |   |
| `location` | `string` | no |   |
| `format` | `string` | no | Values: `"TSV"`, `"CSV"`, `"XML"`. |
| `default_currency` | `string` | no |   |
| `status` | `string` | no | Values: `"ACTIVE"`, `"INACTIVE"`, `"DELETED"`. |
| `preferred_processing_schedule` | `object` | no |   |

### `pinterest_catalog_items_batch_upsert` [#pinterest_catalog_items_batch_upsert]

**Pinterest Ads: Catalog Items Batch Upsert** · create or change, €29 plan · creates an object on each call

Batch upsert (create or update) catalog items. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `country` | `string` | yes |   |
| `language` | `string` | yes |   |
| `operation` | `string` | yes | Values: `"UPSERT"`, `"DELETE"`, `"UPDATE"`, `"CREATE"`. |
| `items` | `object[]` | yes | Array of catalog item objects. |
| `catalog_id` | `string` | no |   |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_product_groups_create` [#pinterest_catalog_product_groups_create]

**Pinterest Ads: Catalog Product Groups Create** · create or change, €29 plan · creates an object on each call

Create a product group for catalog ads targeting. DEPENDENCY: access\_token + feed\_id or catalog\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | yes | Product group name. |
| `description` | `string` | no |   |
| `filters` | `object` | no | Filter criteria for products. |
| `feed_id` | `string` | no |   |
| `catalog_id` | `string` | no |   |
| `catalog_type` | `string` | no | Values: `"RETAIL"`, `"HOTEL"`, `"TRAVEL"`, `"LOCAL"`. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_product_groups_update` [#pinterest_catalog_product_groups_update]

**Pinterest Ads: Catalog Product Groups Update** · create or change, €29 plan · creates an object on each call

Update a product group name, description, or filters. DEPENDENCY: access\_token + product\_group\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `product_group_id` | `string` | yes | Product group unique identifier. |
| `name` | `string` | no |   |
| `description` | `string` | no |   |
| `filters` | `object` | no |   |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalogs_create` [#pinterest_catalogs_create]

**Pinterest Ads: Catalogs Create** · create or change, €29 plan · creates an object on each call

Create a new catalog. The Pinterest API v5 can neither update nor delete a catalog (/catalogs has GET and POST only): create one only if it must stay. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | yes | Catalog name. |
| `catalog_type` | `string` | yes | Values: `"RETAIL"`, `"HOTEL"`, `"TRAVEL"`, `"LOCAL"`. |
| `ad_account_id` | `string` | no |   |

### `pinterest_conversion_events_send` [#pinterest_conversion_events_send]

**Pinterest Ads: Conversion Events Send** · create or change, €29 plan · creates an object on each call

Send conversion events to Pinterest (server-side conversion API). DEPENDENCY: access\_token (conversion token) + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `test` | `boolean` | no | Send as test events (not counted in reports). |
| `data` | `object[]` | yes | Array of conversion event objects. |

### `pinterest_conversion_tags_create` [#pinterest_conversion_tags_create]

**Pinterest Ads: Conversion Tags Create** · create or change, €29 plan · creates an object on each call

Create a Pinterest conversion tag for website tracking. The Pinterest API v5 can neither update nor delete a conversion tag (/conversion\_tags has GET and POST only): create one only if it must stay. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `name` | `string` | yes | Tag name. |
| `aem_enabled` | `boolean` | no | Enable Advanced Match (AEM). |
| `md_frequency` | `number` | no | Frequency for match data uploads. |
| `aem_fnln_enabled` | `boolean` | no | Enable first/last name matching. |
| `aem_ph_enabled` | `boolean` | no | Enable phone number matching. |
| `aem_ge_enabled` | `boolean` | no | Enable gender matching. |
| `aem_db_enabled` | `boolean` | no | Enable date of birth matching. |
| `aem_loc_enabled` | `boolean` | no | Enable location matching. |

### `pinterest_keywords_create` [#pinterest_keywords_create]

**Pinterest Ads: Keywords Create** · create or change, €29 plan · creates an object on each call

Create keywords for targeting in an ad group. DEPENDENCY: access\_token + ad\_account\_id + ad\_group\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `keywords` | `object[]` | yes | Array of keyword objects to create. |

### `pinterest_keywords_update` [#pinterest_keywords_update]

**Pinterest Ads: Keywords Update** · create or change, €29 plan · creates an object on each call

Update bid or status for existing keywords. DEPENDENCY: access\_token + ad\_account\_id + keyword\_id(s).

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `keywords` | `object[]` | yes |   |

### `pinterest_lead_ads_subscriptions_create` [#pinterest_lead_ads_subscriptions_create]

**Pinterest Ads: Lead Ads Subscriptions Create** · create or change, €29 plan · creates an object on each call

Subscribe to lead ad data for an ad account (webhook delivery). Returns the subscription id; read it with lead\_ads\_subscriptions\_get, delete it with lead\_ads\_subscriptions\_delete. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `webhook_url` | `string` | no | HTTPS URL for webhook delivery. |
| `lead_form_id` | `string` | no | Filter to a specific lead form. |
| `partner_access_token` | `string` | no |   |
| `partner_refresh_token` | `string` | no |   |

### `pinterest_user_account_follow_user` [#pinterest_user_account_follow_user]

**Pinterest Ads: User Account Follow User** · create or change, €29 plan · creates an object on each call

Follow a Pinterest user. DEPENDENCY: access\_token + username.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `username` | `string` | yes | Username to follow. |
| `ad_account_id` | `string` | no |   |

### `pinterest_user_account_following` [#pinterest_user_account_following]

**Pinterest Ads: User Account Following** · create or change, €29 plan · creates an object on each call

Get the list of users the authenticated user is following. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `bookmark` | `string` | no |   |
| `page_size` | `integer` | no |   |
| `feed_type` | `string` | no | Values: `"CREATOR"`, `"PINNER"`. |
| `explicit_following` | `boolean` | no |   |
| `ad_account_id` | `string` | no |   |

### `pinterest_user_account_following_boards` [#pinterest_user_account_following_boards]

**Pinterest Ads: User Account Following Boards** · create or change, €29 plan · creates an object on each call

Get the list of boards the authenticated user is following. DEPENDENCY: access\_token.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `bookmark` | `string` | no |   |
| `page_size` | `integer` | no |   |
| `explicit_following` | `boolean` | no |   |
| `ad_account_id` | `string` | no |   |

## Delete (€29) [#suppression]

Served with the €29 plan. A deletion targets one object at a time.

### `pinterest_ad_accounts_delete_sandbox` [#pinterest_ad_accounts_delete_sandbox]

**Pinterest Ads: Ad Accounts Delete Sandbox** · delete, €29 plan, one object at a time · creates an object on each call

Delete all campaigns/ads/etc. in a sandbox ad account. Only works for sandbox accounts. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Unique identifier of the ad account. |

### `pinterest_audiences_delete` [#pinterest_audiences_delete]

**Pinterest Ads: Audiences Delete** · delete, €29 plan, one object at a time · creates an object on each call

Delete ONE audience by audience\_id (irreversible), by the REMOVE operation of Pinterest. DEPENDENCY: access\_token + ad\_account\_id + audience\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `audience_id` | `string` | yes | Audience to delete (one only). |

### `pinterest_bulk_upsert` [#pinterest_bulk_upsert]

**Pinterest Ads: Bulk Upsert** · delete, €29 plan, one object at a time · creates an object on each call

Bulk create or update campaigns, ad groups, ads, or keywords in one request. Returns a bulk\_request\_id for polling. DEPENDENCY: access\_token + ad\_account\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `campaigns` | `object[]` | no |   |
| `ad_groups` | `object[]` | no |   |
| `ads` | `object[]` | no |   |
| `keywords` | `object[]` | no |   |
| `product_groups` | `object[]` | no |   |

### `pinterest_catalog_feeds_delete` [#pinterest_catalog_feeds_delete]

**Pinterest Ads: Catalog Feeds Delete** · delete, €29 plan, one object at a time · creates an object on each call

Delete a catalog feed. DEPENDENCY: access\_token + feed\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `feed_id` | `string` | yes | Feed unique identifier. |
| `ad_account_id` | `string` | no |   |

### `pinterest_catalog_product_groups_delete` [#pinterest_catalog_product_groups_delete]

**Pinterest Ads: Catalog Product Groups Delete** · delete, €29 plan, one object at a time · creates an object on each call

Delete a product group. DEPENDENCY: access\_token + product\_group\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `product_group_id` | `string` | yes | Product group unique identifier. |
| `ad_account_id` | `string` | no |   |

### `pinterest_keywords_delete` [#pinterest_keywords_delete]

**Pinterest Ads: Keywords Delete** · delete, €29 plan, one object at a time · creates an object on each call

Delete ONE keyword (Pinterest archives it, which is irreversible: it disappears from its parent list and stops receiving metrics). Pass the ad group (or campaign) that holds it. DEPENDENCY: access\_token + ad\_account\_id + keyword\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `keyword_id` | `string` | yes | ID of the keyword to delete (one only). |
| `ad_group_id` | `string` | no | Ad group that holds the keyword (read before and after; not sent). |
| `campaign_id` | `string` | no | Campaign that holds the keyword, when it is not in an ad group (read before and after; not sent). |

### `pinterest_lead_ads_subscriptions_delete` [#pinterest_lead_ads_subscriptions_delete]

**Pinterest Ads: Lead Ads Subscriptions Delete** · delete, €29 plan, one object at a time · creates an object on each call

Delete ONE lead ad subscription by subscription\_id (irreversible: the webhook stops receiving leads). DEPENDENCY: access\_token + ad\_account\_id + subscription\_id.

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `ad_account_id` | `string` | yes | Ad account unique identifier. |
| `subscription_id` | `string` | yes | Lead ads subscription to delete (one only). |
