Push API \ Publish a pin on Pinterest

Resource/URI POST
Facebook · Publish a post on a user's profile /push/identities/<identity_token>/facebook/post.json Publish User Post
Facebook · Upload a picture on behalf of a user /push/identities/<identity_token>/facebook/picture.json Upload User Picture
Facebook · Upload a video on behalf of a user /push/identities/<identity_token>/facebook/video.json Upload User Video
Facebook · Publish a post to a group the user is member of /push/identities/<identity_token>/facebook/group/post.json Publish Group Post
Facebook · Upload a picture to a group the user is member of /push/identities/<identity_token>/facebook/group/picture.json Upload Group Picture
Facebook · Upload a video to a group the user is member of /push/identities/<identity_token>/facebook/group/video.json Upload Group Video
Facebook · Publish a post on a page the user administers /push/identities/<identity_token>/facebook/page/post.json Publish Page Post
Facebook · Upload a picture on behalf of a page that the user administers /push/identities/<identity_token>/facebook/page/picture.json Upload Page Picture
Facebook · Upload a video on behalf of a page that the user administers /push/identities/<identity_token>/facebook/page/video.json Upload Page Video
LinkedIn · Publish a post on a user's profile /push/identities/<identity_token>/linkedin/post.json Publish User Post
LinkedIn · Publish a post on a company page the user administers /push/identities/<identity_token>/linkedin/company/post.json Publish Company Post
Pinterest · Publish a pin on behalf of a user /push/identities/<identity_token>/pinterest/board/<board_id>/pin.json Publish Pin
Pinterest · Publish a board on behalf of a user /push/identities/<identity_token>/pinterest/board.json Publish Board
Twitter · Publish a tweet on a user's timeline /push/identities/<identity_token>/twitter/post.json Publish Tweet
Twitter · Upload a picture on behalf of a user /push/identities/<identity_token>/twitter/picture.json Upload Picture
Twitter · Upload a video on behalf of a user /push/identities/<identity_token>/twitter/video.json Upload Video
YouTube · Publish a video on behalf of a user /push/identities/<identity_token>/youtube/video.json Upload Video
YouTube · Add a video to a playlist /push/identities/<identity_token>/youtube/playlist/<playlist_id>/video.json Add Video to Playlist
YouTube · Create a playlist on behalf of a user /push/identities/<identity_token>/youtube/playlist.json Create Playlist
YouTube · Add a section to a user's channel /push/identities/<identity_token>/youtube/channel/section.json Add Channel Section

Workflow

Request: the code to send to the API

Send an API request to the following endpoint in order to post a new pin on behalf of a Pinterest user:

POST /push/identities/<identity_token>/pinterest/board/<board_id>/pin.json

The <identity_token> is obtained whenever one of your users connects using his Pinterest account. The <board_id> must be the identifier of a board owned by the same user.

To be able to use this endpoint, Pinterest must be fully configured for your OneAll Site. The options Read Boards, Read Pins, Write Boards and Write Pins must be enabled and the user must have given consent to publish content on his behalf when he logged in with Pinterest.

POST data to include in the request

    {
      "request": {
        "push": {
          "pin": {
            "title": "#title#",
            "picture": "#picture#",      
            "description": "#description#",      
            "board_section_id": "#board_section_id#",      
            "link": "#link#"
          }
        }
      }
    }
Key Description
*#title# The Pin title. Example: Stadium
*#picture# The fully qualified URL of the picture to share.
Example: https://www.fcbarcelona.com/stadium.jpg
#description# The description of the picture being shared.
Example: Photo of the stadium
#link# The fully qualified URL of the link to attach to the pin.
Example: https://www.fcbarcelona.com/
#board_section_id# The board section to which this Pin belongs.
Example: 123456789012345678

Result: the code returned by the API

Resultset Example

{
  "response": {
    "request": {
      "date": "Fri, 25 Jan 2018 12:00:53  0200",
      "resource": "/push/identities/12345678-ABCD-WXYZ-1234-ABCABCABCABC/pinterest/board/98765432101011/pin.json",
      "status": {
        "flag": "success",
        "code": 200,
        "info": "Your request has been processed successfully"
      }
    },
    "result": {
      "data": {
          "provider": "pinterest",
          "object": "pin",
          "pin_id": "123456789012345678",
          "pin_board_id": "98765432101011",
          "pin_picture": "https://www.oneall.com/logo.jpg",
          "pin_title": "OneAll",
          "pin_description": "User Integration as a service",
          "pin_created_at": "2021-10-20T16:32:10",
          "pin_link": "https://www.oneall.com/"
      }
    }
  }
}

User Contributed Notes