How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pinterest Bulk API

The Bulk API from Pinterest — 3 operation(s) for bulk.

Pinterest Bulk API is one of 117 APIs that Pinterest publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Bulk. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 3 operations across 3 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 5.13.0.

Requests are made against a single base URL, https://api.pinterest.com/v5.

3 operations 3 paths 50 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.13.0
Base URL
https://api.pinterest.com/v5
Authentication
OAuth 2.0, HTTP Bearer, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 3

Pinterest Bulk API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (pinterest_oauth2) using the authorizationCode flow, exposing 18 scopes. It accepts HTTP bearer tokens (conversion_token). It accepts HTTP basic authentication (basic).

  • conversion_token — This security scheme only applies to the conversion events endpoint (POST /adaccounts/{adaccountid}/events). This endpoint requires a bearer token generated vi…

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Bulk 3
POST
/ad_accounts/{ad_account_id}/bulk/download
Get advertiser entities in bulk
bulk_download/create 1 param body → 200default
POST
/ad_accounts/{ad_account_id}/bulk/upsert
Create/update ad entities in bulk
bulk_upsert/create 1 param body → 200default
GET
/ad_accounts/{ad_account_id}/bulk/{bulk_request_id}
Download advertiser entities in bulk
bulk_request/get 3 params → 200default

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are AdCommon (19 properties), AdGroupCommon (18 properties), ProductGroupPromotion (17 properties), TargetingSpec (11 properties). Each schema is shown below with its type and property counts.

QuizPinResult
objectnull
The result, and link out, based on the users choice.
5 properties
ProductGroupPromotionCreateRequest
object
2 properties 2 required
MatchTypeResponse
stringnull
Keyword match type
CampaignCreateCommon
object
CampaignCommon
object
Campaign Data
10 properties
BulkUpsertRequest
object
Two set of objects to be managed asyncronusly by bulk. One for creations, one for modifications.
2 properties
CampaignIsFlexibleDailyBudgets
boolean
Determine if a campaign has flexible daily budgets setup.
ProductGroupPromotionUpdateRequest
object
2 properties 2 required
KeywordsCommon
object
3 properties 2 required
OptimizationGoalMetadata
object
3 properties
AdUpdateRequest
object
AdPinId
object
1 property
BulkOutputFormat
string
Bulk file output format
BulkEntityType
string
Refers ads entity type
ProductGroupPromotion
object
17 properties
GridClickType
stringnull
Where a user is taken after clicking on an ad in grid. Note: This parameter is read-only and is set to DIRECTTODESTINATION by default for direct links supporte…
TargetingSpec
object
Ad group targeting specification defining the ad group target audience. For example, {"APPTYPE":["iphone"], "GENDER":["male"], "LOCALE":["en-US"], "LOCATION":[…
11 properties
ProductGroupPromotionCreateRequestElement
object
QuizPinOption
objectnull
This field contains multiple options to a quiz question.
2 properties
CampaignSummaryStatus
string
Summary status for campaign
CampaignUpdateRequest
object
EntityStatus
string
Entity status
BulkDownloadResponse
object
1 property
TrackingUrls
objectnull
Third-party tracking URLs. Up to three tracking URLs - with a max length of 2,000 - are supported for each event type. Tracking URLs set at the ad group or ad…
5 properties
ObjectiveType
string
Campaign objective type. If set as one of ["AWARENESS", "CONSIDERATION", "WEBCONVERSION", "CATALOGSALES"] the campaign is considered as a Campaign Budget Optim…
BulkDownloadRequest
object
Ad entities to get in bulk request.
5 properties
CreativeType
string
Ad creative type enum. For update, only draft ads may update creative type. Note: SHOPTHEPIN has been deprecated. Please use COLLECTION instead.
KeywordUpdate
object
3 properties 1 required
AdCreateRequest
object
QuizPinQuestion
objectnull
A specific quiz inquiry.
3 properties
BulkUpsertRequestUpdate
object
Request for creation of entities in bulk.
5 properties
BulkUpsertRequestCreate
object
Request for creation of entities in bulk.
5 properties
AdGroupUpdateRequest
object
Error
object
2 properties 2 required
BulkUpsertResponse
object
ID of the bulk request.
1 property
PlacementGroupType
string
Campaign placement group type
BudgetType
string
Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the endtime parameter is REQUIRED, and the ad group s…
KeywordsRequest
object
2 properties 2 required
PacingDeliveryType
string
Ad group pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a da…
ActionType
string
Ad group billable event type. For update, only draft ad groups may update billable event.
AdGroupCommon
object
18 properties
CampaignIsAutomatedCampaign
boolean
Specifies whether the campaign was created in the automated campaign flow
CampaignId
object
1 property
BulkUpsertStatusResponse
object
ID of the bulk request.
2 properties
BulkUpsertStatus
string
CampaignCreateRequest
object
CampaignIsCampaignBudgetOptimization
boolean
Determines if a campaign automatically generate ad-group level budgets given a campaign budget to maximize campaign outcome. When transitioning from non-cbo to…
AdGroupCreateRequest
object
QuizPinData
objectnull
This field includes all quiz data including questions, options, and results.
2 properties
AdCommon
object
Creation fields
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinterest-bulk-api-openapi.yml Raw ↑

Other APIs Pinterest publishes across the network.

Pinterest Access API
Pinterest Accounts API
Pinterest Ad API
Pinterest Ad_groups API
Pinterest Ads API
Pinterest Analytics API
Pinterest Assets API
Pinterest Audience API
Pinterest Audience_insights API
Pinterest Audiences API
Pinterest Batch API
Pinterest Bid API
Where this information came from

This is an independent, third-party profile of Pinterest Bulk API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.