Compartir a través de

Using the Conversions API Payload Builder

Warning

Deprecation Notice
The Marketing Version 202406 (Marketing June 2024) has been sunset. We recommend that you migrate to the latest versioned APIs to avoid disruptions. See the Migration page for more details. If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.

Important

With the Conversions API Payload Builder, you can:

  • Create a sample payload for your Conversions API request.
  • Make real-time API calls using the sample payload.

Developers sending requests to an API need a seamless experience to understand the schema and required parameters. They should be able to construct request payloads with sample data to validate the structure of their API requests.

Currently, the payload builder supports building the payload for streaming the Conversion Events.

Fill out the required and optional fields with sample values to see the payload structure for LinkedIn API requests.

Payload Builder Capabilities

To support developers in integrating the API effectively, the Payload Builder provides the following capabilities:

  • Versioning: Versioning headers are provided.
  • Request Configuration: Clearly list required and optional fields for:
    • Query parameters
    • Headers
    • Request payload
  • Code Generation: Code with sample requests gets created in JSON and cURL format.
  • Error Handling & Guidance: Display clear warnings and actionable steps for developers to correct any invalid data inputs.
  • API Call Execution: Allows developers to make API calls directly from the Payload Builder interface, enabling them to test their payloads in real-time.

This document explains how to use the Payload Builder for the Conversions API.

Prerequisites

Procedure

  1. Open the Developer portal.
  2. Navigate to My Apps and choose the application.
  3. Go to the Products tab, scroll to the Conversions API tile, and select Payload Builder.

    Note

    This opens a template builder screen where you can configure the required Conversions Payload.

  4. In the Conversions Direct API Template Builder screen, provide the URN of the conversion rule in the Partner Conversion URN field. The format of your input should be urn:lla:llaPartnerConversion:XXX, where you must replace "XXX" with the respective URN number. For more information, refer to the following documentation:
  5. Provide the timestamp when the conversion event occurred in the Time text box.

    Note

    The time should be in epoch millisecond format. For example, 1700000000000.

  6. Provide the Unique User Values like idValue and idType for a list of unique identifiers to match the conversion user with existing records.

    Note

    Additional Unique User Values can be added by choosing the + Add more option.

  7. (Optional) Add additional parameters using Add Parameters, such as userInfo, lead, or externalIds if you want these parameters in your payload.
  8. In the Conversion Data section, provide the Currency Code and Amount.

    Note

    Use the standard ISO 4217 currency code.

  9. (Optional) If you want to use deduping, provide the eventId in the Event Data field.

    Note

    In the right-side Code section, the payload is rendered in both JSON and cURL based on the parameters you have added.

  10. (Optional) To make an API call with the payload:
    1. In the Make an API Call section, choose an app.
      Note: You can use the Generate OAuth access token option to generate a LinkedIn access token for an app that has access to the Conversions API. Alternatively, you can use an existing OAuth access token that has the following permission scopes: r_ads, rw_conversions.
    2. Enter your OAuth access Token or generate a new one.
    3. Select the required Ad Account from the dropdown.
      Note: Ensure that the ad account contains at least one conversion rule. If you do not have an ad account, refer to Create Ad Account to create one. To create a conversion rule, see create a conversion rule.
    4. Choose the required Conversion rule from the dropdown.
    5. Select Call API to execute the request.
      You can now view the following upon choosing to call the API:
      • You can view the payload in the Code section, which can be used for further consumption.
      • The API response will be displayed in the Response panel.
      • The event gets created in the production environment.