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 Batch API

The Batch API from Pinterest — 2 operation(s) for batch.

Pinterest Batch 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 Batch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 53 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.

2 operations 2 paths 53 schemas 1 GET1 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 Batch 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 2

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

Batch 2
POST
/catalogs/items/batch
Operate on item batch
items_batch/post 1 param body → 200400401403default
GET
/catalogs/items/batch/{batch_id}
Get catalogs item batch status
items_batch/get 2 params → 200401403404405default

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are UpdatableItemAttributes (45 properties), CatalogsUpdatableHotelAttributes (17 properties), CatalogsUpdatableCreativeAssetsAttributes (12 properties), CatalogsCreativeAssetsItemsBatch (6 properties). Each schema is shown below with its type and property counts.

CatalogsVerticalBatchRequest
object
A request object that can have multiple operations on a single batch
CatalogsCreateCreativeAssetsItem
object
A creative assets item to be created.
3 properties 3 required
CatalogsCreateHotelItem
object
A hotel item to be created.
3 properties 3 required
CatalogsUpdateCreativeAssetsItem
object
A creative assets item to be updated.
3 properties 3 required
CatalogsHotelAttributes
object
CatalogsRetailItemsBatch
object
Object describing the catalogs retail items batch
6 properties 1 required
CatalogsDeleteRetailItem
object
An item to be deleted
2 properties 2 required
CatalogsItemsUpsertBatchRequest
object
Request object to upsert catalogs items
4 properties 4 required
ItemAttributesRequest
object
CatalogsCreateRetailItem
object
An item to be created
3 properties 3 required
ItemDeleteDiscontinuedBatchRecord
object
Object describing an item batch record to discontinue items
1 property
ItemUpdateBatchRecord
object
Object describing an item batch record to update items
3 properties
ItemValidationEvent
object
Object describing an item validation event
3 properties
CatalogsItemsDeleteBatchRequest
object
Request object to delete catalogs items
4 properties 4 required
CatalogsItemsUpdateBatchRequest
object
Request object to update catalogs items
4 properties 4 required
CatalogsHotelAddress
object
5 properties
ItemCreateBatchRecord
object
Object describing an item batch record to create items
2 properties
CatalogsItemsDeleteDiscontinuedBatchRequest
object
Request object to discontinue catalogs items
4 properties 4 required
CatalogsCreativeAssetsBatchRequest
object
Request object to update catalogs creative assets items
5 properties 4 required
CatalogsUpsertRetailItem
object
An item to be upserted
3 properties 3 required
CatalogsUpsertHotelItem
object
A hotel item to be upserted.
3 properties 3 required
ItemDeleteBatchRecord
object
Object describing an item batch record to delete items
1 property
CatalogsUpdatableHotelAttributes
object
17 properties
CatalogsHotelBatchRequest
object
Request object to update catalogs hotel items
5 properties 4 required
CatalogsCreativeAssetsBatchItem
object
Creative assets batch item
ItemProcessingStatus
string
The status of the item processing record
UpdatableItemAttributes
object
45 properties
Country
string
Country ID from ISO 3166-1 alpha-2.
BatchOperationStatus
string
The status of the operation performed by the batch
CatalogsUpsertCreativeAssetsItem
object
A creative assets item to be upserted.
3 properties 3 required
CatalogsHotelBatchItem
object
Hotel batch item
CatalogsRetailBatchRequest
object
A request object that can have multiple operations on a single retail batch
4 properties 4 required
CatalogsCreativeAssetsItemsBatch
object
Object describing the catalogs creative assets items batch
6 properties 1 required
Error
object
2 properties 2 required
CatalogsType
string
Type of the catalog entity.
CatalogsUpdateRetailItem
object
An item to be updated
4 properties 3 required
UpdateMaskFieldType
string
The field types supported by the update mask
CatalogsUpdatableCreativeAssetsAttributes
object
12 properties
CatalogsCreativeAssetsAttributes
object
CatalogsDeleteHotelItem
object
A hotel item to be deleted
2 properties 2 required
CatalogsUpdateHotelItem
object
Object describing an hotel item batch record
3 properties 3 required
HotelProcessingRecord
object
Object describing an item processing record
4 properties
CatalogsHotelGuestRatings
object
If specified, you must provide all properties
4 properties
Language
string
Language code, which is among the offical ISO 639-1 language list.
CatalogsItemsBatchRequest
object
Request object of catalogs items batch
CatalogsHotelItemsBatch
object
Object describing the catalogs hotel items batch
6 properties 1 required
ItemUpsertBatchRecord
object
Object describing an item batch record to upsert items
2 properties
CatalogsItemsBatch
object
Object describing the catalogs items batch
1 property 1 required
CatalogsDeleteCreativeAssetsItem
object
A creative assets item to be deleted
2 properties 2 required
CreativeAssetsProcessingRecord
object
Object describing an item processing record
4 properties
ItemProcessingRecord
object
Object describing an item processing record
4 properties
BatchOperation
string
The operation performed by the batch. The DELETEDISCONTINUED operation only updates availablity to "Out of Stock".
CatalogsItemsCreateBatchRequest
object
Request object to create catalogs items
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinterest-batch-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 Bid API
Pinterest Billing API
Where this information came from

This is an independent, third-party profile of Pinterest Batch 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.