openapi_generated.pinterest_client.PinsApi

All URIs are relative to https://api.pinterest.com/v5

Method	HTTP request	Description
pins_analytics	GET /pins/{pin_id}/analytics	Get Pin analytics
pins_create	POST /pins	Create Pin
pins_delete	DELETE /pins/{pin_id}	Delete Pin
pins_get	GET /pins/{pin_id}	Get Pin
pins_list	GET /pins	List Pins
pins_save	POST /pins/{pin_id}/save	Save Pin
pins_update	PATCH /pins/{pin_id}	Update Pin

pins_analytics

PinAnalyticsResponse pins_analytics(pin_id, start_date, end_date, metric_types)

Get Pin analytics

Get analytics for a Pin owned by the "operation user_account" - or on a group board that has been shared with this account. - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via <a href="https://developers.pinterest.com/docs/api/v5/#operation/ad_accounts/list\">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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access roles on the ad_account: - For Pins on public or protected boards: Admin, Analyst. - For Pins on secret boards: Admin.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.pin_analytics_response import PinAnalyticsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    pin_id = "pin_id_example" # str | Unique identifier of a Pin.
    start_date = dateutil_parser('1970-01-01').date() # date | Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
    end_date = dateutil_parser('1970-01-01').date() # date | Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
    metric_types = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | Pin metric types to get data for, default is all.
    app_types = "ALL" # str | Apps or devices to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    split_field = "NO_SPLIT" # str | How to split the data into groups. Not including this param means data won't be split. (optional) if omitted the server will use the default value of "NO_SPLIT"
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get Pin analytics
        api_response = api_instance.pins_analytics(pin_id, start_date, end_date, metric_types)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_analytics: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Pin analytics
        api_response = api_instance.pins_analytics(pin_id, start_date, end_date, metric_types, app_types=app_types, split_field=split_field, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_analytics: %s\n" % e)

Parameters

Name	Type	Description	Notes
pin_id	str	Unique identifier of a Pin.
start_date	date	Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
end_date	date	Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
metric_types	[[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md)	Pin metric types to get data for, default is all.
app_types	str	Apps or devices to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
split_field	str	How to split the data into groups. Not including this param means data won't be split.	[optional] if omitted the server will use the default value of "NO_SPLIT"
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

PinAnalyticsResponse

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	response	-
400	Invalid pins analytics parameters.	-
403	Not authorized to access board or Pin.	-
404	Pin not found.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pins_create

Pin pins_create(pin_create)

Create Pin

Create a Pin on a board or board section owned by the "operation user_account". Note: If the current "operation user_account" (defined by the access token) has access to another user's Ad Accounts via Pinterest Business Access, you can modify your request to make use of the current operation_user_account's permissions to those Ad Accounts by including the ad_account_id in the path parameters for the request (e.g. .../?ad_account_id=12345&...). - This function is intended solely for publishing new content created by the user. If you are interested in saving content created by others to your Pinterest boards, sometimes called 'curated content', please use our Save button instead. For more tips on creating fresh content for Pinterest, review our Content App Solutions Guide. Learn more about video Pin creation.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.pin import Pin
from openapi_generated.pinterest_client.model.pin_create import PinCreate
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    pin_create = PinCreate(
        link="https://www.pinterest.com/",
        title="title_example",
        description="description_example",
        dominant_color="#6E7874",
        alt_text="alt_text_example",
        board_id="4",
        board_section_id="4",
        media_source={},
        parent_pin_id="4",
        note="note_example",
    ) # PinCreate | Create a new Pin.
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create Pin
        api_response = api_instance.pins_create(pin_create)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_create: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create Pin
        api_response = api_instance.pins_create(pin_create, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pin_create	PinCreate	Create a new Pin.
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

Pin

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful pin creation.	-
400	Invalid Pin parameters response	-
403	The Pin's image is too small, too large or is broken	-
404	Board or section not found	-
429	This request exceeded a rate limit. This can happen if the client exceeds one of the published rate limits or if multiple write operations are applied to an object within a short time window.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pins_delete

pins_delete(pin_id)

Delete Pin

Delete a Pins owned by the "operation user_account" - or on a group board that has been shared with this 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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">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.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    pin_id = "pin_id_example" # str | Unique identifier of a Pin.
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Delete Pin
        api_instance.pins_delete(pin_id)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_delete: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Delete Pin
        api_instance.pins_delete(pin_id, ad_account_id=ad_account_id)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
pin_id	str	Unique identifier of a Pin.
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

void (empty response body)

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successfully deleted Pin	-
403	Not authorized to access board or Pin.	-
404	Pin not found.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pins_get

Pin pins_get(pin_id)

Get Pin

Get a Pin owned by the "operation user_account" - or on a group board that has been shared with this 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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">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.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.pin import Pin
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    pin_id = "pin_id_example" # str | Unique identifier of a Pin.
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get Pin
        api_response = api_instance.pins_get(pin_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_get: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Pin
        api_response = api_instance.pins_get(pin_id, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
pin_id	str	Unique identifier of a Pin.
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

Pin

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	response	-
403	Not authorized to access board or Pin.	-
404	Pin not found.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pins_list

bool, date, datetime, dict, float, int, list, str, none_type pins_list()

List Pins

Get a list of the Pins owned by the "operation user_account". - By default, the "operation user_account" is the token user_account. - All Pins owned by the "operation user_account" are included, regardless of who owns the board they are on. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.paginated import Paginated
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    bookmark = "bookmark_example" # str | Cursor used to fetch the next page of items (optional)
    pin_filter = "exclude_native" # str | Pin filter. (optional)
    include_protected_pins = False # bool | Specify if return pins from protected boards (optional) if omitted the server will use the default value of False
    pin_type = "PRIVATE" # str | The type of pins to return, currently only enabled for private pins (optional) if omitted the server will use the default value of "PRIVATE"
    creative_types = [
        "REGULAR",
    ] # [str] | Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. (optional)
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List Pins
        api_response = api_instance.pins_list(bookmark=bookmark, pin_filter=pin_filter, include_protected_pins=include_protected_pins, pin_type=pin_type, creative_types=creative_types, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
bookmark	str	Cursor used to fetch the next page of items	[optional]
pin_filter	str	Pin filter.	[optional]
include_protected_pins	bool	Specify if return pins from protected boards	[optional] if omitted the server will use the default value of False
pin_type	str	The type of pins to return, currently only enabled for private pins	[optional] if omitted the server will use the default value of "PRIVATE"
creative_types	[str]	Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.	[optional]
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid pin filter value	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pins_save

Pin pins_save(pin_id, inline_object)

Save Pin

Save a Pin on a board or board section owned by the "operation 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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">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. - Any Pin type can be saved: image Pin, video Pin, Idea Pin, product Pin, etc. - Any public Pin can be saved given a pin ID.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.pin import Pin
from openapi_generated.pinterest_client.model.inline_object import InlineObject
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    pin_id = "pin_id_example" # str | Unique identifier of a Pin.
    inline_object = InlineObject(
        board_id="4",
        board_section_id="4",
    ) # InlineObject | 
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Save Pin
        api_response = api_instance.pins_save(pin_id, inline_object)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_save: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Save Pin
        api_response = api_instance.pins_save(pin_id, inline_object, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_save: %s\n" % e)

Parameters

Name	Type	Description	Notes
pin_id	str	Unique identifier of a Pin.
inline_object	InlineObject
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

Pin

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successfully saved pin.	-
403	Not authorized to access Board or Pin.	-
404	Board or Pin not found.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pins_update

Pin pins_update(pin_id, pin_update)

Update Pin

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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">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.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import pins_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.pin import Pin
from openapi_generated.pinterest_client.model.pin_update import PinUpdate
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pins_api.PinsApi(api_client)
    pin_id = "pin_id_example" # str | Unique identifier of a Pin.
    pin_update = PinUpdate(
        alt_text="alt_text_example",
        board_id="4",
        board_section_id="4",
        description="description_example",
        link="https://www.pinterest.com/",
        title="title_example",
        carousel_slots=[
            PinUpdateCarouselSlots(
                title="title_example",
                description="description_example",
                link="link_example",
            ),
        ],
        note="note_example",
    ) # PinUpdate | 
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update Pin
        api_response = api_instance.pins_update(pin_id, pin_update)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_update: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update Pin
        api_response = api_instance.pins_update(pin_id, pin_update, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling PinsApi->pins_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
pin_id	str	Unique identifier of a Pin.
pin_update	PinUpdate
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

Pin

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	response	-
403	Not authorized to update Pin.	-
404	Pin not found.	-
429	This request exceeded a rate limit. This can happen if the client exceeds one of the published rate limits or if multiple write operations are applied to an object within a short time window.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PinsApi.md

Latest commit

History

PinsApi.md

File metadata and controls

openapi_generated.pinterest_client.PinsApi

pins_analytics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pins_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pins_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pins_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pins_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pins_save

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pins_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details