Pinterest allows you to create a bulletin of photos called a Board. You can follow boards, add pins to existing ones or collaborate with people to build shared boards.
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
List boards I follow |
|
List boards I follow (V2) |
|
List my boards |
|
List my boards (V2) |
|
Create board |
|
Create board (V2) |
|
EditBoard (string board, [Optional]string name, [advanced][Optional]string description) |
Edit board |
List all pins |
|
List all pins (V2) |
|
List pins from a board |
|
CreatePin (string board, string note, string image_url, [advanced][Optional]string link) |
Create pin |
Create pin (V2) |
|
Edit pin |
|
Edit pin (V2) |
|
Get current user |
|
Get current user (V2) |
|
List my followers |
|
List my followers (V2) |
|
List my followings |
|
List my followings (V2) |
Name |
Summary |
When pin is added to followed board |
|
When pin is added to my board |
|
When someone follows me |
|
When someone follows me (V2) |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List boards I follow
Description: List boards I follow
Syntax:
Pinterest.ListFollowBoards ()
Returns:
Type:BoardResponse
Description: BoardResponse
Summary: List boards I follow (V2)
Description: List boards I follow
Syntax:
Pinterest.ListFollowBoards_V2 ()
Returns:
Type:BoardResponse
Description: BoardResponse
Summary: List my boards
Description: List my boards
Syntax:
Pinterest.ListMyBoards ()
Returns:
Type:BoardResponse
Description: BoardResponse
Summary: List my boards (V2)
Description: List my boards
Syntax:
Pinterest.ListMyBoards_V2 ()
Returns:
Type:BoardResponse
Description: BoardResponse
Summary: Create board
Description: Create board
Syntax:
Pinterest.CreateBoard (string name, [Optional]string description)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
name |
string (Name) |
Name |
True |
|
description |
string (Description) |
Description |
False |
Returns:
Type:BoardResponseData
Description: BoardResponseData
Summary: Create board (V2)
Description: Create board
Syntax:
Pinterest.CreateBoard_V2 (string name, [Optional]string description)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
name |
string (Name) |
Name |
True |
|
description |
string (Description) |
Description |
False |
Returns:
Type:BoardResponseData
Description: BoardResponseData
Summary: Edit board
Description: Edit board
Syntax:
Pinterest.EditBoard (string board, [Optional]string name, [advanced][Optional]string description)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board |
string (Board) |
Board |
True |
|
name |
string (Name) |
Name |
False |
|
description |
string (Description) |
Description |
False |
Returns:
Type:BoardResponseData
Description: BoardResponseData
Summary: List all pins
Description: List all pins
Syntax:
Pinterest.ListAllPins ()
Returns:
Type:PinResponse
Description: PinResponse
Summary: List all pins (V2)
Description: List all pins
Syntax:
Pinterest.ListAllPins_V2 ()
Returns:
Type:PinResponse
Description: PinResponse
Summary: List pins from a board
Description: List pins from a board
Syntax:
Pinterest.ListPinsFromBoard (string board)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board |
string (Board) |
Board |
True |
Returns:
Type:PinResponse
Description: PinResponse
Summary: Create pin
Description: Create pin
Syntax:
Pinterest.CreatePin (string board, string note, string image_url, [advanced][Optional]string link)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board |
string (Board) |
Board |
True |
|
note |
string (Note) |
The user-entered description of the pin |
True |
|
image_url |
string (Image Url) |
The link to the image that you want to pin (source) |
True |
|
link |
string (Link) |
The url the pin will link to when you click through |
False |
Returns:
Type:PinResponseData
Description: PinResponseData
Summary: Create pin (V2)
Description: Create pin
Syntax:
Pinterest.CreatePin_V2 (string board_id, string description, string image_url, [advanced][Optional]string link)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board_id |
string (Board) |
Board |
True |
|
description |
string (Description) |
The user-entered description of the pin |
True |
|
image_url |
string (Image Url) |
The link to the image that you want to pin (source) |
True |
|
link |
string (Link) |
The url the pin will link to when you click through |
False |
Returns:
Type:PinResponseData
Description: PinResponseData
Summary: Edit pin
Description: Edit pin
Syntax:
Pinterest.EditPin (string board, string pin, string note, [advanced][Optional]string link, [Optional]string secondBoard)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board |
string (Board) |
Board |
True |
|
pin |
string (Pin) |
Pin |
True |
|
note |
string (Note) |
The user-entered description of the pin |
True |
|
link |
string (Link) |
The url the pin will link to when you click through |
False |
|
secondBoard |
string (Board to move pin to) |
The board to move the pin to |
False |
Returns:
Type:PinResponseData
Description: PinResponseData
Summary: Edit pin (V2)
Description: Edit pin
Syntax:
Pinterest.EditPin_V2 (string board_id, string pin, string description, [advanced][Optional]string link, [Optional]string secondBoard)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board_id |
string (Board) |
Board |
True |
|
pin |
string (Pin) |
Pin |
True |
|
description |
string (Note) |
The user-entered description of the pin |
True |
|
link |
string (Link) |
The url the pin will link to when you click through |
False |
|
secondBoard |
string (Board to move pin to) |
The board to move the pin to |
False |
Returns:
Type:PinResponseData
Description: PinResponseData
Summary: Get current user
Description: Get current user
Syntax:
Pinterest.GetCurrentUser ()
Returns:
Type:CurrentUserResponse
Description: CurrentUserResponse
Summary: Get current user (V2)
Description: Get current user
Syntax:
Pinterest.GetCurrentUser_V2 ()
Returns:
Type:CurrentUserResponse
Description: CurrentUserResponse
Summary: List my followers
Description: List my followers
Syntax:
Pinterest.ListMyFollowers ()
Returns:
Type:UserResponse
Description: UserResponse
Summary: List my followers (V2)
Description: List my followers
Syntax:
Pinterest.ListMyFollowers_V2 ()
Returns:
Type:UserResponse
Description: UserResponse
Summary: List my followings
Description: List my followings
Syntax:
Pinterest.ListMyFollowings ()
Returns:
Type:UserResponse
Description: UserResponse
Summary: List my followings (V2)
Description: List my followings
Syntax:
Pinterest.ListMyFollowings_V2 ()
Returns:
Type:UserResponse
Description: UserResponse
Summary: When pin is added to followed board
Description: When pin is added to followed board
Syntax:
Pinterest.OnPinAddedToFollowedBoard (string board)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board |
string (Board) |
Board |
True |
Returns:
Type:PinResponse
Description: PinResponse
Summary: When pin is added to my board
Description: When pin is added to my board
Syntax:
Pinterest.OnPinAddedToMyBoard (string board)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
board |
string (Board) |
Board |
True |
Returns:
Type:PinResponse
Description: PinResponse
Summary: When someone follows me
Description: When someone follows me
Syntax:
Pinterest.OnSomeoneFollowsMe ()
Returns:
Type:UserResponse
Description: UserResponse
Summary: When someone follows me (V2)
Description: When someone follows me
Syntax:
Pinterest.OnSomeoneFollowsMe_V2 ()
Returns:
Type:UserResponse
Description: UserResponse
Summary:
Description: BoardResponse
Properties:
Name |
Type |
Summary |
data |
array of (BoardResponseData) Board Data |
Board Data |
Summary:
Description: BoardResponseData
Properties:
Name |
Type |
Summary |
url |
string Url |
Url |
id |
string Id |
Id |
name |
string Name |
Name |
Summary:
Description: CurrentUserResponse
Properties:
Name |
Type |
Summary |
data |
User Data |
User Data |
Summary: User Data
Description: User Data
Properties:
Name |
Type |
Summary |
Summary:
Description: PinResponse
Properties:
Name |
Type |
Summary |
data |
array of (PinResponseData) Pin Data |
Pin Data |
Summary:
Description: PinResponseData
Properties:
Name |
Type |
Summary |
url |
string Url |
Url |
note |
string Note |
Note |
description |
string Description |
Description |
link |
string Link |
Link |
id |
string Id |
Id |
Summary:
Description: UserResponse
Properties:
Name |
Type |
Summary |
data |
array of (UserResponseData) User Data |
User Data |
page |
|
UserResponsePage |
Summary:
Description: UserResponseData
Properties:
Name |
Type |
Summary |
url |
string Url |
Url |
first_name |
string First name |
First name |
last_name |
string Last Name |
Last Name |
id |
string Id |
User Id |
username |
string Username |
Username |
Summary:
Description: UserResponsePage
Properties:
Name |
Type |
Summary |
cursor |
string Cursor |
Cursor |
next |
string Next |
Next |