PIpinterest
pins

Update Pin

Changed on

Update a pin owned by the "operating 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.

This endpoint is currently in beta and not available to all apps. Learn more.

patch/pins/{pin_id}

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    • OAuth 2
      Authorization codehttps://www.pinterest.com/oauth/
      Token URLhttps://api.pinterest.com/v5/oauth/token
      Scopesboards:read, boards:write, pins:read, pins:write
    • or OAuth 2
      Client credentials
      Token URLhttps://api.pinterest.com/v3/oauth/access_token/
      Scopesboards:read, boards:write, pins:read, pins:write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

pin_idstring required

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

alt_textstring nullable
board_idstring

The board to which this Pin belongs.

board_section_idstring nullable

The board section to which this Pin belongs.

descriptionstring nullable
linkstring nullable
titlestring nullable

Response

The request has succeeded.

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
creative_type'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' | 'COLLAGE' | 'MAX_WIDTH_REGULAR_COLLECTION' | 'MAX_WIDTH_VIDEO_COLLECTION' | 'APP'

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

  • v5b698c180678aRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added to the response body allOf list for the response status

  • v514c297539b64Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      added the new COLLAGE enum value to the / response property for the response status

    • warning

      added the new MAX_WIDTH_REGULAR_COLLECTION enum value to the / response property for the response status

    • warning

      added the new MAX_WIDTH_VIDEO_COLLECTION enum value to the / response property for the response status