Pinterest
Developers
Docs
Log in
Pinterest Marketing API
Notices
Changelog
March 2022
Ads API v3 Shutdown
Update to top pins metric sort options
November 2021
Engagement Audiences
Deprecation of Top Repins endpoint
September 2021
Idea ads (beta)
Slideshow for Collections
August 2021
Idea ads with paid partnership
July 2021
Ads API v4 release
June 2021
Deprecating two product feed endpoints
February 2021
Pin formats
[Ads] disregard campaign objective_type WEB_SESSIONS
January 2021
Pin Create endpoint now has option to include alternative text
Updated click reporting metrics
Removal of curated content from Analytics
November 2020
Deprecation of description field for Save Endpoint
October 2020
Ads: Delivery metrics definitions display name
Documentation updates
September 2020
Ads: Delivery metrics definitions
Multiple Redirect URIs
Subscribe for updates
Contact Us
Technical Support
Feedback
Getting Started
Introduction
Welcome to the Pinterest Marketing API.
Content
Analytics
Ads
Pinner
Shopping
Audience
Tags and Domain
API Access
Apply for an App
Redirect URIs
Authentication
User Authorization
Start the OAuth flow (explicit, server side)
Receive the access code upon user grant
Exchange the code for an access token
Access tokens
OAuth scopes
Client Authorization
Prepare signature string
Sign the request
Make API requests
Content
Quick Start: Publish Video
Using video APIs
Video pin metrics and analytics
Analytics
Quick Start: Reporting
User and Pin
Pin stats
Ad Group, Campaign, and Pin promotion
Organic metrics
Advertising
Audience Insights
Account Sharing examples
Migration: Creator Stats
User profile stats
Creator Pin stats
Ads
Quick Start: Ads Overview
API Reference
Rate Limits
Pagination
API Response Codes
Account Sharing
Implementing account sharing
Account roles
Role actions
Reporting
Metrics
Metric report types
Ads Enums
Ad group summary status
Bid strategy type
Billable event
Billing status
Billing type
Budget type
Campaign objective
Campaign summary status
Campaign upgrade status
Catalog product group type
Conversion event
Conversion tag type
Conversion learning mode type.
Creative type
Entity status
Entity type
Entity version
Match type (keyword).
Metric types
Pacing delivery type
Pin formats
Pin promotion review status
Pin promotion status
Pinner (audience) list type
Placement
Placement group
Tracking URL event
User list type
User role
Video pin metric types
Visibility group
Roles and Actions
Endpoints - Ads (v3)
ad groups
post
Create ad group
get
Get ad group
put
Update ad group
get
Get ad group delivery metrics
get
Get ad group keywords
get
Get ad group targeting delivery metrics
get
Get ad group pin promotions
get
Get ad group product groups
advertisers
get
Get advertisers
get
Get advertiser (/me)
get
Get advertiser
get
Get advertiser app event tracking configurations
put
Update advertiser app event tracking configuration
get
Get advertiser audiences
get
Get advertiser boards
post
Create advertiser board
get
Get advertiser campaigns
get
Get advertiser campaigns summary
get
Get advertiser customer lists
post
Delete advertiser user data
get
Get advertiser delivery metrics
post
Request batch advertiser entities report
get
Get batch advertiser entities report
get
Get insights metrics from a given audience scope and type
get
Get category sub-interest information
get
Get available audience scope and type for insights
get
Get advertiser negative keywords
get
Get advertiser conversion events
get
Get advertiser order lines
get
Get advertiser organic pins
get
Search advertiser organic pins
get
Get advertiser Pinterest tags
post
Redeem advertiser marketing offer
audiences
post
Create audience
put
Delete audience
get
Get audience
put
Update audience
batch campaigns
post
Create advertiser campaigns
put
Update advertiser campaigns
batch pin promotions
post
Create pin promotions
put
Update pin promotions.
bill receipt
get
Get paid bill receipt
billing data
get
Get advertiser billing data
boards (ads)
del
Delete board
put
Update board
put
Set board cover
get
Get board pins
post
Create board pin
books closed
get
Get conversion metrics ready state
campaigns
post
Create campaign
get
Get campaign
put
Update campaign
get
Get campaign ad groups
get
Get campaign delivery metrics
get
Get campaign keyword delivery metrics
get
Get campaign negative keywords
get
Get campaign pin promotions
get
Get campaign product filters
post
Apply a product filter to a campaign
customer lists
post
Create customer list
put
Append customer list/audience records
put
Remove customer list/audience records
get
Get customer list
keywords
post
Create keywords
put
Update keywords' archived fields
get
Get country keywords' metrics
get
Get related keywords and metrics per source and country
order lines
get
Get order line
pin promotions
post
Create pin promotion
get
Get bid floors
post
Get bid floors
get
Get bid guidance
post
Get bid guidance
get
Get pin promotion
put
Update pin promotion
get
Get pin promotion delivery metrics
get
Get pin promotion targeting delivery metrics
pincarousel (ads)
put
Upload pin carousel images
pins (ads)
del
Delete pin
get
Get organic pin
put
Update pin
previews
post
Create ad preview with image
post
Create ad preview with pin
post
Create pin preview with pin URL (DEPRECATED)
post
Create pin preview with pin ID (DEPRECATED)
get
Get pin preview (DEPRECATED)
reports
get
Get async advertiser delivery metrics report
post
Request async advertiser delivery metrics report
resources
get
Get advertiser countries
get
Get delivery metrics' definitions
get
Get available targeting types
get
Get single interest information
get
Get ads targeting values
scheduled reports
post
Create scheduled report
get
Get completed scheduled reports
put
Update scheduled report
tags
post
Create Pinterest tag
del
Delete Pinterest tag
get
Get Pinterest tag
put
Update Pinterest tag name and/or status
get
Get Pinterest tag configurations
put
Update Pinterest tag configurations
terms
get
Get related terms
get
Get suggested terms
Endpoints - Organic (v3)
aggregated comments
get
Get comment replies
aggregated pin data
get
Get a list of AggregatedComments left on the AggregatedPinData.
analytics
get
Get user metrics
get
Get user's top pin metrics
get
Get user's top video pin metrics
board section
del
Delete board section
get
Get board section's pins
get
Get board sections
put
Create board section
boards
put
Create board
del
Delete board
get
Get board
post
Update board
del
Unfollow board
put
Follow board
get
Get board pins
catalogs
get
Get merchant product feed report
get
Get merchant workflow information
post
Request catalog product feed validation
get
Get catalog status messages
get
Get merchant available filters
get
Get merchant product count
post
Get merchant product count
get
Get merchant product pins
post
Get merchant product pins
get
Get merchant product groups
post
Create merchant product group
put
Update merchant product group
get
Get merchant metadata
put
Update merchant metadata
get
Verify user domain
commerce
post
Create a product pin merchant
get
Get a merchant
post
Add merchant product pin feed profile
post
Merchant feed profile validation request
get
Check for validation results
put
Update merchant product pin feed profile
domains
del
Unverify viewing user's verified domain
get
Get domain verification information
get
Get domain information
get
Get domain pins
get
Get domain verificatiion information
post
Verify domain
post
Verify domain in realtime
get
Get your domain pins
get
Get pin's related pins
get
Get domain's top sample pins
get
Get most clicked pins
get
Search a domain's pins
measurement
get
Get conversion quality health metrics
media
post
Edit media (video) - trim, crop, or rotate
get
Get media upload status(es)
get
Get user media upload status(es)
post
Register and upload media
oauth