We've launched API explorer, a new tool to view real responses from GET endpoints directly at our API documentation site!
To try it out, make sure you have an active production access token. Then, navigate to a GET endpoint (for example, ) and toggle "API Explorer" on the right side. Input your request options and your access token, then hit "Run" to see the response. We've increased item batch size from 100 to 1000 items per call for the so that merchants can interpret information related to their items at scale.
We've also added support to and product groups to help merchants further manage their catalog and campaign creation.
New Endpoints: Manage Business Asset Groups
New asset group endpoints allow businesses to create custom groups of assets based on geography, brand, and vertical.
We have three new endpoints:
Updates to Limited Data Processing
Texas and Oregon were added to the list of states eligible for Limited Data Processing due to new laws passed that will take effect on July 1. We've added the ability to get targeting analytics for Quiz Ads. When using the endpoint, you can send QUIZ_RESULT as the targeting_types to get targeting analytics reports broken down by quiz results.
Two endpoints have been introduced which allows catalog item-level bidding. These endpoints are advanced features only available to select users.
New objective type: Video completion objective
We are excited to announce the launch of a new Video Completion objective type for video ads. This new objective type allows you to optimize your campaigns for video completion events, to capture users likely to view a video to completion.
With the introduction of the video completion objective, you can now pass the new VIDEO_COMPLETION enum under OBJECTIVE_TYPE when creating or updating campaigns.
[BETA] Lead Ads now enabled through Pinterest API
Lead ads are only available to select advertisers. If you are interested in trying them out, reach out to your account manager.
You can now create and manage lead ads and lead forms through the Pinterest API. Lead ads provide a unique opportunity to connect with potential customers who are actively seeking your products or services on Pinterest. People on Pinterest can share their information with you by filling out a form within your lead ad, without having to leave the Pinterest app or website.
In order to create a lead ad, you must first create a lead form using the endpoint and then use the endpoint with the lead form ID. After a lead ad has been run, you can use the new endpoints to retrieve the lead ad data.
Advertisers must agree to Pinterest's terms of service for creating a lead ad using the parameter in and/or before a lead form can be created. Note: Lead ad data will be available up to 30 days after the lead has been submitted. Lead ads are currently only supported for campaigns with Conversions objective optimizing for WEB_CONVERSIONS or TRAFFIC with REGULAR or VIDEO Ads.
New endpoints: Audience Sharing
Audience Sharing endpoints are not available to all apps, if you are interested in using them, reach out to us on our help center page. Learn more. We are pleased to introduce new Audience sharing endpoints on the Pinterest API, enabling advertisers and businesses to share audiences seamlessly across multiple accounts within the same business hierachy. These endpoints allow you to share existing audiences between ad accounts or businesses to save time and repeat successful tactics without having to recreate the same audiences for each account.
Sharing audiences from ad accounts
Sharing audience from business accounts
New Sorting Parameter for Ad Account Analytics Endpoint
We have added the ability to change the sorting order for ad account analytics reports for the endpoint. You can now use the parameter to select the sorting option for your analytics reports. Options include sorting by date or by ID. Note: Sorting by date is recommended for large requests.
Endpoint deprecation: Get Catalog Items
On May 30th we will be deprecating the endpoint, please use the instead to perform the same requests. The Post catalog item endpoint improves performance for developers requesting large amounts of item_ids.
Required scopes change for Get catalog items and Post Get catalog items
On May 10th, we will be changing the scopes required to call and endpoints. To access these endpoints you must request and when creating an access token. Previously only scope was required. If the access token does not have the correct permissions on May 10th you will receive an Unauthorized error.
New endpoints: Business access management
We've launched new business access endpoints in the Pinterest API. These endpoints will enable businesses to easily manage user permissions for employees and partners working on their Pinterest accounts and brings Business Manager capabilities to the API. For more information on how permissions are managed at Pinterest, refer to our these articles:
API Reference now organized by common use cases
The API Reference tab now organizes endpoints under common use cases. Endpoints were previously ordered alphabetically.
New support: Targeting Templates now enabled
Targeting templates allow advertisers to save a set of targeting details including audience lists, keywords & interest, demographics, and placements to use more than once during the campaign creation process. The new endpoints allow advertisers to save and re-use previously saved targeting templates during the ad group creation process.
We are also adding a new parameter for Create Ad Group and Update Ad Group to allow the use of existing targeting templates when creating or updating ad groups. We currently only support 1 targeting template per ad group. When using targeting templates to create an ad group, do not set any other targeting fields including: targeting_spec, tracking_urls, auto_targeting_enabled, placement_group
Ads grid_click_type parameter change to read-only field
The parameter is now read-only. For ad types supported by direct links, we no longer support the option to switch to a closeup grid experience. Direct links is the only supported click behavior for the following ad types:
Static image ads, standard video, Carousel, and Idea ads in Consideration and Conversion campaigns.
Travel catalogs and all shopping ads on static image and video in Catalog Sales campaigns.
If you pass a value in a request to the or endpoints we will ignore the value. All other changes sent within your request will still be recognized. Coming March 28: Replacing VISIT_WEBSITE with VISIT_SITE
We've recently launched the ability to create ads with more customized CTA options by passing an enum for customizable_cta_type when using or . On March 28th we will be deprecating the CTA option of VISIT_WESBITE and replaced it with VISIT_SITE. Please use VISIT_SITE instead. This change will also be reflected when using for an ad using these CTAs.
Change of method for GET/audience sizing
We've recently noticed an error in our design of the Get audience sizing endpoint which was causing bugs in the response when different targeting specs are requested. In order to resolve the issue, we will be making a breaking change to the method for this endpoint.
On March 11, we will be changing the method of the Audience Sizing endpoint from to . Please use the method to call the Get audience sizing endpoint to resolve any issues you may have been receiving. Users can now request organic Pin analytics for up to 100 Pin IDs at a time with a new endpoint. The change introduces a new Get Multiple Pin Analytics endpoint with a pin_ids parameter which accepts a list of up to 100 IDs. Request beta access through our Help Center.
You can now use the parameter to filter results by specific keywords. This update further aligns the endpoint with UI behavior. We are enabling Shopping API endpoints in the sandbox environment.
This change affects all endpoints.