Update API \ Update a pin on Pinterest PHP SDK
Resource/URI | PUT | DELETE |
---|---|---|
Facebook · Page Post
/update/identities/<identity_token>/facebook/page/<pageid>/post/<postid>.json
|
Update Page Post | Delete Page Post |
Facebook · Page Picture
/update/identities/<identity_token>/facebook/page/<pageid>/picture/<pictureid>.json
|
- | Delete Page Picture |
Facebook · Page Video
/update/identities/<identity_token>/facebook/page/<pageid>/video/<videoid>.json
|
- | Delete Page Video |
Pinterest · Pin
/update/identities/<identity_token>/pinterest/pin/<pinid>.json
|
Update Pin | Delete Pin |
Twitter · Tweet
/update/identities/<identity_token>/twitter/post/<postid>.json
|
- | Delete Tweet |
Workflow
Request: the code to send to the API
Send an API request to the following endpoint in order to update a pin posted on Pinterest:
The <identity_token>
is obtained whenever one of your users connects using his Pinterest account.
The <pinid>
must correspond to the identifier of a pin published
using our API and/or owned by the same user.
To be able to use this endpoint, Pinterest must be fully configured for your OneAll Site. The option Publish Actions must be enabled and the user must have given consent to publish content on his behalf when he logged in with Pinterest.
PUT
data to include in the request
{ "request": { "update": { "pin": { "board": "#board-name#", "description": "#description#", "link": "#link#" } } } }
Key | Description |
---|---|
#board-name# |
The board on which the Pin is posted. The list of the user's boards can be retrieved using our Pull API. Example: photos |
#description# |
The new description of the Pin. Example: Photo of the stadium |
#link# |
The fully qualified URL of the link attached to the Pin. Example: https://www.fcbarcelona.com/ |
Result: the code returned by the API
The API either returns a HTTP status code 200
if the Pin was updated successfully
or an appropriate message body with further details on the error that occured.
Response Example
{ "response": { "request": { "date": "Mon, 04 Nov 2019 16:12:58 +0100", "resource": "/update/identities/2af20011-8965-471b-8f6b-8b66a611aae6/pinterest/pin/352969689546669253.json", "status": { "flag": "success", "code": 200, "info": "Your request has been processed successfully" } }, "result": { "data": { "provider": "pinterest", "object": "pin", "pin_id": "352969689546669253", "pin_picture": "https://i.pinimg.com/originals/e5/94/f7/e594f7888dbb59c7d4bfceff76a25a80.jpg", "pin_description": "User Integration as a service", "pin_link": "https://www.oneall.com/", "pin_location": "https://www.pinterest.com/pin/352969689546669253/" } } } }