Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Pinterest location.
pinterest_api.png

Pinterest API

Create a Pinterest Destination

  1. Click the + icon on the Nexset that will be sent to the Pinterest destination, and select the Send to Destination option from the menu.

  2. Select the Pinterest connector from the list of available destination connectors. Then, select the credential that will be used to connect to your Pinterest account, and click Next; or, create a new Pinterest credential for use in this flow.

  3. In Nexla, Pinterest destinations can be created using pre-built endpoint templates, which expedite destination setup for common Pinterest endpoints. Each template is designed specifically for the corresponding Pinterest endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Pinterest destinations can also be configured manually, allowing you to send data to Pinterest endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Pinterest endpoints. Each template is designed specifically for the corresponding Pinterest endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Post a pin

    This endpoint template creates a pin in your Pinterest account using records from a Nexset. Use this template when you need to create new pins for content sharing, marketing campaigns, or other pin management purposes.

    • Enter the ad account ID in the Ad account ID field. This should be the unique identifier of an ad account (default: 123456789123456789). The ad account ID is used for advertising-related pins. This field is optional and can be left empty if you're not creating advertising pins.

    This endpoint sends data as JSON in the request body to create pins in your Pinterest account. Each record from your Nexset will be sent as a separate API request to create a new pin in Pinterest. The request body should contain the pin data in the format required by the Pinterest API.

    The pin structure must match the Pinterest API's expected format. For detailed information about pin creation, request body formats, available pin properties, and pin management, see the Pinterest API documentation.

    Post board

    This endpoint template creates a Pinterest board in your Pinterest account using records from a Nexset. Use this template when you need to create new boards for organizing pins, content curation, or other board management purposes.

    • Enter the ad account ID in the Ad account ID field. This should be the unique identifier of an ad account (default: 123456789123456789). The ad account ID is used for advertising-related boards. This field is optional and can be left empty if you're not creating advertising boards.

    This endpoint sends data as JSON in the request body to create boards in your Pinterest account. Each record from your Nexset will be sent as a separate API request to create a new board in Pinterest. The request body should contain the board data in the format required by the Pinterest API.

    The board structure must match the Pinterest API's expected format. For detailed information about board creation, request body formats, available board properties, and board management, see the Pinterest API documentation.

Configure Manually

Pinterest destinations can be manually configured to send data to any valid Pinterest API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Pinterest API after each call to a new Nexla webhook data source.

API Method

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Pinterest API from the Method pulldown menu. Pinterest API typically uses POST method for creating resources.

Data Format

  1. Select the format in which the Nexset data will be sent to the Pinterest API from the Content Format pulldown menu. Pinterest API expects JSON format for all requests.

API Endpoint URL

  1. Enter the URL of the Pinterest API endpoint to which data will be sent in the URL field. This should be the complete URL to your Pinterest endpoint (e.g., https://api.pinterest.com/v5/pins, https://api.pinterest.com/v5/boards). Include any required query parameters in the URL (e.g., ?ad_account_id={ad_account_id}).

Ensure the API endpoint URL is correct and accessible with your current credentials. The Pinterest API endpoint URL should point to the endpoint where you want to create resources. The endpoint URL should include the API version (/v5/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Request Body

  1. Configure the request body that will be sent to the Pinterest API. The request body should contain the resource data formatted as JSON, with field names matching the Pinterest API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Pinterest API's expected format for the specific endpoint you're using. Pinterest API uses specific structures for different endpoints (pins, boards, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the Pinterest API documentation.

Save the Destination

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.