Connectors Reference

Pinterest

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

 

Actions:

Name

Summary

ListFollowBoards ()

List boards I follow

ListMyBoards ()

List my boards

CreateBoard (string name, [Optional]string description)

Create board

EditBoard (string board, [Optional]string name, [advanced][Optional]string description)

Edit board

ListAllPins ()

List all pins

ListPinsFromBoard (string board)

List pins from a board

CreatePin (string board, string note, string image_url, [advanced][Optional]string link)

Create pin

EditPin (string board, string pin, string note, [advanced][Optional]string link, [Optional]string secondBoard)

Edit pin

GetCurrentUser ()

Get current user

ListMyFollowers ()

List my followers

ListMyFollowings ()

List my followings

 

Triggers:

Name

Summary

OnPinAddedToFollowedBoard (string board)

When pin is added to followed board

OnPinAddedToMyBoard (string board)

When pin is added to my board

OnSomeoneFollowsMe ()

When someone follows me

 

Objects:

Name

Summary

BoardResponse

 

BoardResponseData

 

CurrentUserResponse

 

PinResponse

 

PinResponseData

 

UserResponse

 

UserResponseData

 

UserResponsePage

 

 

Actions:

ListFollowBoards

Summary: List boards I follow

Description: List boards I follow

 

Syntax:

Pinterest.ListFollowBoards ()

 

Returns:

          Type:BoardResponse

          Description: BoardResponse

 

ListMyBoards

Summary: List my boards

Description: List my boards

 

Syntax:

Pinterest.ListMyBoards ()

 

Returns:

          Type:BoardResponse

          Description: BoardResponse

 

CreateBoard

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

 

EditBoard

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

ListMyBoards

name

string

(Name)

Name

False

description

string

(Description)

Description

False

 

Returns:

          Type:BoardResponse

          Description: BoardResponse

 

ListAllPins

Summary: List all pins

Description: List all pins

 

Syntax:

Pinterest.ListAllPins ()

 

Returns:

          Type:PinResponse

          Description: PinResponse

 

ListPinsFromBoard

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

ListMyBoards

 

Returns:

          Type:PinResponse

          Description: PinResponse

 

CreatePin

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

ListMyBoards

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

 

EditPin

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

ListMyBoards

pin

string

(Pin)

Pin

True

ListPinsFromBoard

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

ListMyBoards

 

Returns:

          Type:PinResponse

          Description: PinResponse

 

GetCurrentUser

Summary: Get current user

Description: Get current user

 

Syntax:

Pinterest.GetCurrentUser ()

 

Returns:

          Type:CurrentUserResponse

          Description: CurrentUserResponse

 

ListMyFollowers

Summary: List my followers

Description: List my followers

 

Syntax:

Pinterest.ListMyFollowers ()

 

Returns:

          Type:UserResponse

          Description: UserResponse

 

ListMyFollowings

Summary: List my followings

Description: List my followings

 

Syntax:

Pinterest.ListMyFollowings ()

 

Returns:

          Type:UserResponse

          Description: UserResponse

 

Triggers:

Trigger OnPinAddedToFollowedBoard

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

ListFollowBoards

 

Returns:

          Type:PinResponse

          Description: PinResponse

 

Trigger OnPinAddedToMyBoard

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

ListMyBoards

 

Returns:

          Type:PinResponse

          Description: PinResponse

 

Trigger OnSomeoneFollowsMe

Summary: When someone follows me

Description: When someone follows me

 

Syntax:

Pinterest.OnSomeoneFollowsMe ()

 

Returns:

          Type:UserResponse

          Description: UserResponse

 


 

BoardResponse

Summary:

Description: BoardResponse

 

          Properties:

Name

Type

Summary

data

array of (BoardResponseData)

Board Data

Board Data


 

BoardResponseData

Summary:

Description: BoardResponseData

 

          Properties:

Name

Type

Summary

url

string

Url

Url

id

string

Id

Id

name

string

Name

Name


 

CurrentUserResponse

Summary:

Description: CurrentUserResponse

 

          Properties:

Name

Type

Summary

data

Data

User Data

User Data

 

Data

Summary: User Data

Description: User Data

 

          Properties:

Name

Type

Summary

 


 

PinResponse

Summary:

Description: PinResponse

 

          Properties:

Name

Type

Summary

data

array of (PinResponseData)

Pin Data

Pin Data


 

PinResponseData

Summary:

Description: PinResponseData

 

          Properties:

Name

Type

Summary

url

string

Url

Url

note

string

Note

Note

link

string

Link

Link

id

string

Id

Id


 

UserResponse

Summary:

Description: UserResponse

 

          Properties:

Name

Type

Summary

data

array of (UserResponseData)

User Data

User Data

page

UserResponsePage

 

UserResponsePage


 

UserResponseData

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


 

UserResponsePage

Summary:

Description: UserResponsePage

 

          Properties:

Name

Type

Summary

cursor

string

Cursor

Cursor

next

string

Next

Next