Pinterest integration

Create pins, manage boards, and browse your Pinterest content.

Social mediaOAuth6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
createPin
createBoard
deletePin
findBoardByName
findPin
updateBoard
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("pinterest", "createPin", {
    "board_id": "<board_id>",
    "title": "<title>",
    "media_source_type": "image_url",
    "media_url": "<media url>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Pinterest answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "pinterest-createpin",
  name: "Pinterest: Create Pin",
  description: "Calls Pinterest when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("pinterest", {
      "action": "createPin",
      "board_id": "<board_id>",
      "title": "<title>",
      "media_source_type": "image_url",
      "media_url": "<media url>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/pinterest/createPin" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"board_id":"<board_id>","title":"<title>","media_source_type":"image_url","media_url":"<media url>"}}'

Actions

createPinin catalog

Create Pin. Upload an image or video to create a new Pin on a board.

Input	Type	Description
`ad_account_id`optional	id (picked from your account)	Ad account Id
`board_id`required	id (picked from your account)	Board Id
`board_section_id`optional	id (picked from your account)	Board Section Id
`title`required	text	The title of the Pin (max 100 characters).
`description`optional	long text	The description of the Pin (max 800 characters).
`media_source_type`required	one of "image_url" \| "image_base64" \| "video_url"	The type of media source for the Pin.
`media_url`required	text	The URL of the image or video to upload. Must be a valid URL.
`link`optional	text	The destination URL that the Pin will link to when clicked.
`dominant_color`optional	text	The dominant color of the Pin as a hex color code (e.g., "#6E7874").
`alt_text`optional	text	Alternative text for accessibility and screen readers (max 500 characters).
`parent_pin_id`optional	text	The ID of the original Pin if this is a saved/repinned Pin.
`sponsor_id`optional	text	The sponsor account ID for paid partnership content. Available only to select users in closed beta.
`product_tags`optional	ids (picked from your account)	Select one or more options
`note`optional	text	A private note for this Pin that only you can see.
`is_removable`optional	boolean	Set to true to create an ad-only Pin that can be easily removed.

createBoard

Create Board. Create a new Pinterest board for organizing Pins.

Input	Type	Description
`ad_account_id`optional	id (picked from your account)	Ad account Id
`name`required	text	The name of the board (max 180 characters).
`description`optional	long text	Optional description for your board.
`privacy`optional	one of "PUBLIC" \| "PROTECTED" \| "SECRET"	Board privacy setting (auto-set to "PROTECTED" for ad-only boards).
`is_ads_only`optional	boolean	Create an ad-only board that can only store promotional Pins. Note: Board name will become "Ad-only Pins" and privacy will be set to "PROTECTED".

deletePin

Delete Pin. Permanently delete a specific Pin.

Input	Type	Description
`pin_id`required	id (picked from your account)	pin Id
`ad_account_id`optional	id (picked from your account)	Ad account Id

findBoardByName

Find Board by Name. Search for boards by name using Pinterest's search API.

Input	Type	Description
`query`required	text	The search term to find boards (required).
`ad_account_id`optional	id (picked from your account)	Ad account Id
`bookmark`optional	text	Pagination bookmark from previous response.

findPin

Find Pin by Title/Keyword. Search for Pins using title, description, or keywords.

Input	Type	Description
`ad_account_id`optional	id (picked from your account)	Ad account Id
`query`required	text	Search terms for pin titles, descriptions, or tags. You can also search using comma-separated pin IDs.
`bookmark`optional	text	Bookmark token from previous search results for pagination.
`max_results`optional	number	Maximum number of pins to return (useful for large result sets).

updateBoard

Update Board. Update a board's name, description, or privacy settings.

Input	Type	Description
`board_id`required	id (picked from your account)	Board Id
`ad_account_id`optional	id (picked from your account)	Ad account Id
`name`optional	text	The new name of the board (max 180 characters). Leave empty to keep current name.
`description`optional	long text	The new description of the board (max 500 characters). Leave empty to keep current description.
`privacy`optional	one of "PUBLIC" \| "PROTECTED" \| "SECRET"	Update board privacy setting. Leave empty to keep current setting.

Details

Id: pinterest
Category: Social media
Tags: social, visual, pins, boards, inspiration
Package: @activepieces/piece-pinterest@0.1.3
Tier: Community