Skip to main content
Pinterest logo
  • Category: social media accounts
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 27
  • Triggers: 0
  • Slug: PINTEREST
  • Version: 20261101_00

Tools

Slug: PINTEREST_CREATE_BOARDCreate a public or secret Pinterest board. Secret creation requires boards:write_secret.

Input Parameters

string
required
Board name (1-50 characters).
string ("PUBLIC" | "SECRET")
PUBLIC or SECRET. PROTECTED and ad-only boards are outside this Organic toolkit.
string
Optional board description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_CREATE_BOARD_SECTIONCreate a named section within a Pinterest board.

Input Parameters

string
required
Section name (1-180 characters).
string
required
Numeric Pinterest board ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_CREATE_PINCreate an image, carousel, or registered-video Pin on a Pinterest board. Production execution requires Pinterest Standard access: Trial apps are explicitly blocked from creating Pins on api.pinterest.com and must use a separately authenticated API Sandbox connection.

Input Parameters

Optional destination URL, up to 2048 characters.
string
Optional Pin title, up to 100 characters.
string
Optional accessible description, up to 500 characters.
string
required
Numeric ID of the destination Pinterest board.
string
Optional Pin description, up to 800 characters.
string
required
Official image URL, image Base64, carousel URL, carousel Base64, or registered-video source. The closed-beta pin_url source is not supported.
string
Optional dominant hexadecimal color, for example #6E7874.
string
Optional numeric ID of a section within the destination board.
array
Optional creator declarations: AI_MODIFIED and/or SYNTHETIC_PERFORMER. Pinterest receives these under ai_disclosures.values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_DELETE_BOARDPermanently delete a Pinterest board by ID, including a secret board when authorized.

Input Parameters

string
required
Numeric ID of the board to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_DELETE_BOARD_SECTIONPermanently delete a section from a Pinterest board.

Input Parameters

string
required
Numeric Pinterest board ID.
string
required
Numeric ID of the section to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_DELETE_PINPermanently delete a Pinterest Pin by ID. Production Pin writes require Pinterest Standard access.

Input Parameters

string
required
Numeric ID of the Pin to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_ACCOUNT_ANALYTICSGet aggregate Pinterest account analytics over a UTC date range, with optional metric, content, platform, source, and split filters.

Input Parameters

string ("ALL" | "YOUR_PINS" | "OTHER_PINS")
Include ALL activity, YOUR_PINS, or OTHER_PINS.
string ("ALL" | "MOBILE" | "TABLET" | "WEB")
App or device filter: ALL, MOBILE, TABLET, or WEB.
string
required
UTC report end date in YYYY-MM-DD format. It must be on or after start_date and no more than 90 days after it.
string ("ALL" | "ORGANIC_IMAGE" | "ORGANIC_PRODUCT" | "ORGANIC_VIDEO" | "ADS_STANDARD" | "ADS_PRODUCT" | "ADS_VIDEO" | "ADS_IDEA")
Pin format to include, or ALL for every supported format.
string
required
UTC report start date in YYYY-MM-DD format. Pinterest allows dates up to 90 days before today.
string ("NO_SPLIT" | "APP_TYPE" | "OWNED_CONTENT" | "SOURCE" | "PIN_FORMAT")
Group results by APP_TYPE, OWNED_CONTENT, SOURCE, or PIN_FORMAT. NO_SPLIT returns one aggregate bucket.
string ("ALL" | "PAID" | "ORGANIC")
Include ALL, PAID, or ORGANIC account activity.
array
Metrics to return. Omit to request Pinterest’s default metric set; multiple values are sent as one comma-separated query value.
string ("OTHER" | "CLAIMED" | "BOTH")
Filter Pins by claimed-domain relationship: OTHER, CLAIMED, or BOTH.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_BOARDGet one Pinterest board by ID, including secret boards available to the connected account.

Input Parameters

string
required
Numeric Pinterest board ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_MEDIAGet a registered Pinterest video’s current upload or processing status by media ID.

Input Parameters

string
required
Numeric Pinterest media registration ID returned by REGISTER_MEDIA.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_PINGet one public or secret Pinterest Pin by ID.

Input Parameters

string
required
Numeric Pinterest Pin ID.
boolean
Include available 90-day and lifetime Pin metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_PIN_ANALYTICSGet daily, summary, and lifetime analytics for one Pinterest Pin over a date range. Recent daily values may remain in PROCESSING status.

Input Parameters

string
required
Numeric Pinterest Pin ID.
string ("ALL" | "MOBILE" | "TABLET" | "WEB")
App or device data to include: ALL, MOBILE, TABLET, or WEB.
string
required
UTC report end date in YYYY-MM-DD format, at most 90 days after start_date.
string
required
UTC report start date in YYYY-MM-DD format, at most 90 days before today.
array
required
Pin metrics to return. Values are sent to Pinterest as one comma-separated query parameter.
boolean
Split analytics into app-type buckets instead of one aggregate bucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_PROFILEGet the connected Pinterest account’s profile and content counts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_TOP_PINSReturn the connected account’s top Pinterest Pins or top video Pins ranked by an analytics metric.

Input Parameters

string
required
Metric used to rank Pins. For pin_kind=all: ENGAGEMENT, SAVE, IMPRESSION, OUTBOUND_CLICK, or PIN_CLICK. For pin_kind=video: SAVE, IMPRESSION, OUTBOUND_CLICK, VIDEO_MRC_VIEW, VIDEO_AVG_WATCH_TIME, VIDEO_V50_WATCH_TIME, QUARTILE_95_PERCENT_VIEW, VIDEO_10S_VIEW, or VIDEO_START.
string
required
UTC report end date in YYYY-MM-DD format. It must be on or after start_date and no more than 90 days after it.
integer
Number of ranked Pins to return (1-50).
string ("all" | "video")
Ranking route to use: all for top Pins or video for top video Pins. The selected route determines the valid sort and metric values.
string
required
UTC report start date in YYYY-MM-DD format. It cannot be more than 90 days before today.
string ("ALL" | "PAID" | "ORGANIC")
Filter analytics to ALL, PAID, or ORGANIC content.
array
Optional metrics to include for each Pin. pin_kind=all accepts ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, and SAVE_RATE. pin_kind=video accepts IMPRESSION, SAVE, OUTBOUND_CLICK, VIDEO_MRC_VIEW, VIDEO_AVG_WATCH_TIME, VIDEO_V50_WATCH_TIME, QUARTILE_95_PERCENT_VIEW, VIDEO_10S_VIEW, and VIDEO_START. Values are sent as one comma-separated query value.
string ("OTHER" | "CLAIMED" | "BOTH")
Filter Pins by claimed-domain ownership: OTHER, CLAIMED, or BOTH.
boolean
When true, restrict results to Pins created in the last 30 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_GET_WEBSITE_VERIFICATIONGet the connected account’s website-claim verification methods and material. The response contains sensitive verification values.

Input Parameters

boolean
Include the potentially large HTML verification file content; false returns only method metadata and filename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_LIST_BOARDSList the connected account’s public, protected, or secret Pinterest boards one page at a time.

Input Parameters

string ("ALL" | "PUBLIC" | "PROTECTED" | "SECRET" | "PUBLIC_AND_SECRET")
Board privacy filter: ALL, PUBLIC, PROTECTED, SECRET, or PUBLIC_AND_SECRET.
string
Opaque bookmark returned by the previous page. Omit for the first page.
integer
Maximum boards to return (1-250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_LIST_BOARD_SECTIONSList sections within a Pinterest board one page at a time.

Input Parameters

string
required
Numeric Pinterest board ID.
string
Opaque bookmark returned by the previous page. Omit for the first page.
integer
Maximum sections to return (1-250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_LIST_PINSList account Pins, Pins on a board, or Pins in a board section using one parameterized read tool. Account-level listing may omit secret-board Pins; provide board_id for reliable secret-board inventory.

Input Parameters

string
Board ID to list from; omit for the account-level Pin list.
string
Opaque bookmark returned by the previous page. Omit for the first page.
integer
Maximum Pins to return (1-250).
string
Section ID to list from; requires board_id.
array
Optional Pin creative-type filters for account or board listing. Pinterest does not support this filter for section listing.
boolean
Include available 90-day and lifetime Pin metrics for account or board listing. Pinterest does not support metrics for section listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_LIST_PROFILE_RESOURCESList the connected Pinterest profile’s followers, followed users, followed boards, claimed websites, or linked businesses, or list followed interests for a specified username.

Input Parameters

string
Opaque bookmark returned by the previous page. Ignored for linked_businesses.
string
Pinterest username required for followed_interests. Use Get Profile to discover the connected account’s username.
string ("ALL" | "RANKED" | "CREATOR_ONLY" | "RANKED_CREATOR_ONLY")
For following_users, select ALL, RANKED, CREATOR_ONLY, or RANKED_CREATOR_ONLY followees.
integer
Maximum resources to return (1-250). Ignored for linked_businesses, which is not paginated.
string ("followers" | "following_users" | "following_boards" | "followed_interests" | "websites" | "linked_businesses")
required
Profile resource to list: followers, following_users, following_boards, followed_interests, websites, or linked_businesses.
boolean
For following_users or following_boards, return only explicitly followed resources when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_REGISTER_MEDIARegister a Pinterest video upload and return the media ID, upload URL, and all multipart parameters required to upload the video before creating a video Pin. This action registers the upload but does not upload video bytes.

Input Parameters

string
Pinterest currently supports only video media registration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_SAVE_PINSave an existing Pinterest Pin to a board or board section and return the new saved Pin.

Input Parameters

string
required
Numeric ID of the existing Pinterest Pin to save.
string
Numeric ID of the destination board.
string
Numeric ID of the destination board section.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_SEARCH_OWN_CONTENTSearch the connected account’s own boards or Pins, including secret content when authorized. This does not search Pinterest’s global partner Pin index.

Input Parameters

string
Text to search in the connected account’s content. Required when resource_type is pins; omit when browsing boards without a search term.
string
Opaque bookmark returned by the previous page. Omit for the first page.
integer
Maximum board results to return (1-250). Pinterest exposes no page-size parameter for Pin search, so this value is ignored when resource_type is pins.
string ("boards" | "pins")
required
Content type to search: boards or pins.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_UPDATE_BOARDUpdate a board’s name, description, or privacy. Provide at least one update field. Secret-board writes require boards:write_secret.

Input Parameters

string
Replacement board name (1-50 characters).
string ("PUBLIC" | "SECRET")
Replacement privacy: PUBLIC or SECRET.
string
required
Numeric Pinterest board ID.
string
Replacement board description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_UPDATE_BOARD_SECTIONRename a section within a Pinterest board.

Input Parameters

string
required
Replacement section name (1-180 characters).
string
required
Numeric Pinterest board ID.
string
required
Numeric Pinterest section ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PINTEREST_UPDATE_PINUpdate content on a Pin owned by the connected account or move it to another board or section. Provide at least one update field. Production Pin writes require Pinterest Standard access. This Organic action does not support Business Access ad-account delegation.

Input Parameters

Replacement destination URL, up to 2048 characters. Pass null to clear it.
string
Replacement Pin title, up to 100 characters. Pass null to clear it.
string
required
Numeric Pinterest Pin ID.
string
Replacement accessible text, up to 500 characters. Pass null to clear it.
string
Numeric destination board ID when moving the Pin.
string
Replacement Pin description, up to 800 characters. Pass null to clear it.
string
Numeric destination section ID when moving the Pin. Pass null to remove the Pin from its current section.
array
Replacement creator AI disclosures. Pass an empty list to clear the declarations; Pinterest receives this as ai_disclosures.values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not