ad_accounts14

ad_groups13

ads10

advanced_auction2

audience_insights2

audience_sharing7

audiences4

billing11

boards11

bulk3

business_access_assets12

business_access_invite6

business_access_relationships9

campaigns8

catalog_feeds8

catalog_items3

catalog_product_groups10

catalog_reports3

catalog_supplemental7

catalogs3

conversion_deletion_requests4

conversion_eqs1

conversion_events1

conversion_tags5

conversions4

customer_list_uploads3

customer_lists4

customer_segment3

integrations7

keywords5

labels5

lead_ads4

lead_forms5

leads_export2

media3

msot_events1

notification1

oauth3

order_lines2

pins8

product_group_promotions5

product_tags3

promotions5

resources6

schedules3

search3

targeting_template3

terms2

terms_of_service1

trends4

user_account14

pins

Save Pin

Save a Pin on a board or board section owned by the "operation user_account".

By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:
For Pins on public or protected boards: Owner, Admin, Analyst, Campaign Manager.
For Pins on secret boards: Owner, Admin.
Any Pin type can be saved: image Pin, video Pin, Idea Pin, product Pin, etc.
Any public Pin can be saved given a pin ID.

post/pins/{pin_id}/save

Path parameters

pin_idstring required

Unique identifier of a Pin.

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

board_idstring nullable

Unique identifier of the board to which the pin will be saved.

board_section_idstring nullable

Unique identifier of the board section to which the pin will be saved.

Response

The request has succeeded and a new resource has been created as a result.

board_idstring

The board to which this Pin belongs.

board_section_idstring nullable

The board section to which this Pin belongs.

created_atstring date-time

Ad creative type enum. Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.

dominant_colorstring nullable

Dominant pin color. Hex number, e.g. #6E7874.

has_been_promotedboolean

Whether the Pin has been promoted or not.

idstring required

is_ownerboolean

Whether the "operation user_account" is the Pin owner.

is_productboolean

Whether the Pin is a product Pin.

is_standardboolean

Whether the Pin is standard or not. See documentation on Changes to Pin creation for more information.

parent_pin_idstring nullable

The source pin id if this pin was saved from another pin. Learn more.

pin_metricsobject nullable

Pin metrics with associated time intervals if any.

Example response

{
  "media": {
    "images": {
      "150x150": {
        "width": 150,
        "height": 150,
        "url": "https://i.pinimg.com/150x150/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
      },
      "400x300": {
        "width": 400,
        "height": 300,
        "url": "https://i.pinimg.com/400x300/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
      },
      "600x": {
        "width": 600,
        "height": 600,
        "url": "https://i.pinimg.com/600x/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
      },
      "1200x": {
        "width": 1200,
        "height": 1200,
        "url": "https://i.pinimg.com/1200x/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
      }
    }
  },
  "pin_metrics": {
    "90d": {
      "pin_click": 7,
      "impression": 2,
      "clickthrough": 3
    },
    "lifetime_metrics": {
      "pin_click": 7,
      "impression": 2,
      "clickthrough": 3,
      "reaction": 10,
      "comment": 2
    }
  }
}

Changes

Changed in 12 of the 29 revisions of this API.121937

Jun 4, 2026v5b698c180678a1124See the full diff
- ▲
  removed the required property id from the response with the 201 status
  response-required-property-removed
- ●
  removed the optional property board_id from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property board_owner from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property board_section_id from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property created_at from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property creative_type from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property dominant_color from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property has_been_promoted from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property is_owner from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property is_standard from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property media from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property parent_pin_id from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property pin_metrics from the response with the 201 status
  response-optional-property-removed
- ○
  added PinBase to the response body allOf list for the response status 201
  response-body-all-of-added
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 16, 2025v514c297539b644See the full diff
- ●
  removed the optional property note from the response with the 201 status
  response-optional-property-removed
- ●
  added the new COLLAGE enum value to the creative_type/allOf[subschema #1: CreativeType enum used ads]/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new MAX_WIDTH_REGULAR_COLLECTION enum value to the creative_type/allOf[subschema #1: CreativeType enum used ads]/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new MAX_WIDTH_VIDEO_COLLECTION enum value to the creative_type/allOf[subschema #1: CreativeType enum used ads]/ response property for the response status 201
  response-property-enum-value-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 2025v57d64d863909a427See the full diff
- ▲
  added PinMediaWithImage PinMediaWithVideo PinMediaWithImages PinMediaWithVideos PinMediaWithImageAndVideo to the media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/ response property oneOf list for the response status 201
  response-property-one-of-added
- ▲
  the board_owner response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the creative_type response's property type/format changed from string/ to / for status 201
  response-property-type-changed
- ▲
  the media response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ●
  removed the optional property is_removable from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property product_tags from the response with the 201 status
  response-optional-property-removed
- ○
  the response optional property id became not read-only for the status 201
  response-optional-property-became-not-read-only
- ○
  the response optional property is_standard became read-only for the status 201
  response-optional-property-became-read-only
- ○
  the response optional property pin_metrics became read-only for the status 201
  response-optional-property-became-read-only
- ○
  removed the optional write-only property media_source from the response with the 201 status
  response-optional-write-only-property-removed
- ○
  removed PinMediaBase subschema #2 from the media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/ response property allOf list for the response status 201
  response-property-all-of-removed
- ○
  the response property id became required for the status 201
  response-property-became-required
- ○
  added discriminator to media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/ response property for the response status 201
  response-property-discriminator-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 16, 2025v543134ca41f182See the full diff
- ○
  added the optional property is_removable to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property product_tags to the response with the 201 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 4, 2025v510f9eba4ad9713See the full diff
- ●
  removed the optional property media/allOf[subschema #1: Pin media]/media_type from the response with the 201 status
  response-optional-property-removed
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_key_frame_time to the response with the 201 status
  response-optional-property-added
- ○
  added PinMediaBase subschema #2 to the media/allOf[subschema #1: Pin media]/ response property allOf list for the response status 201
  response-property-all-of-added
- ○
  removed discriminator from media/allOf[subschema #1: Pin media]/ response property for the response status 201
  response-property-discriminator-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 8, 2024v57529b464d5cb1See the full diff
- ○
  added the optional property pin_metrics to the response with the 201 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 17, 2023v50ff12596bafd2See the full diff
- ○
  the request property board_id became nullable
  request-property-became-nullable
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #6: Pin URL]/is_affiliate_link to the response with the 201 status
  response-optional-property-added
Jul 14, 2023v552586a27477129See the full diff
- ▲
  the response property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_url became optional for the status 201
  response-property-became-optional
- ▲
  added PinMediaSourcePinURL to the media_source/allOf[subschema #1: Pin media source]/ response property oneOf list for the response status 201
  response-property-one-of-added
- ○
  added the optional property has_been_promoted to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property is_owner to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property is_standard to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_content_type to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_data to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property note to the response with the 201 status
  response-optional-property-added
- ○
  added CreativeType to the creative_type response property allOf list for the response status 201
  response-property-all-of-added
- ○
  removed subschema #1: Creative Type from the creative_type response property allOf list for the response status 201
  response-property-all-of-removed
- ○
  added pin_url discriminator mapping keys to the media_source/allOf[subschema #1: Pin media source]/ response property for the response status 201
  response-property-discriminator-mapping-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 12, 2023v5689b4b2676395See the full diff
- ○
  added the new optional query request parameter ad_account_id
  new-optional-request-parameter
- ○
  added the optional property creative_type to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #1: Image Base64]/is_standard to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #2: Image URL]/is_standard to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/is_standard to the response with the 201 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 14, 2023v5be19b77aa78a42See the full diff
- ▲
  the description response property's maxLength was unset from 500 for the response status 201
  response-property-max-length-unset
- ▲
  the title response property's maxLength was unset from 100 for the response status 201
  response-property-max-length-unset
- ▲
  added PinMediaSourceImagesBase64 PinMediaSourceImagesURL to the media_source/allOf[subschema #1: Pin media source]/ response property oneOf list for the response status 201
  response-property-one-of-added
- ▲
  the media/allOf[subschema #1: Pin media]/ response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ○
  added multiple_image_base64 multiple_image_urls discriminator mapping keys to the media_source/allOf[subschema #1: Pin media source]/ response property for the response status 201
  response-property-discriminator-mapping-added
- ○
  the id response's property pattern ^\d+$ was added for the status 201
  response-property-pattern-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (12 revisions)