PIpinterest
notification

Receive notifications from external partners.

Changed on

Used by third-party partners to send notifications to Pinterest. These notifications could be specific for your use-case or generic notification that are accepted by Pinterests' systems. This API is gated and you need to request access to this feature.

post/notifications

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    • OAuth 2
      Authorization codehttps://www.pinterest.com/oauth/
      Token URLhttps://api.pinterest.com/v5/oauth/token
      Scopesuser_accounts:read
    • or OAuth 2
      Client credentials
      Token URLhttps://api.pinterest.com/v3/oauth/access_token/
      Scopesuser_accounts:read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

object[] required

Batch of 1-100 notification objects.

OR
NotificationSingleRequest required

A single notification object.

Response

The request has succeeded.

error_msgstring

error message when success is false

received_atinteger

Received time. Unix timestamp in seconds.

successboolean

Returns true if the notification accepted.

Changes

  • v5b698c180678aRevision changes
    • breaking

      removed subschema #1 from the request body oneOf list

    • info

      added to the request body oneOf list

  • v514c297539b64Revision changes
    • info

      the endpoint scheme security client_credentials was added to the API