# LinkedIn Ads Conversions API Reference

## Destination Info

* Supports [Track](https://documentation.freshpaint.io/developer/freshpaint-sdk-reference#track) calls
* Supports [HIPAA mode](https://documentation.freshpaint.io/hipaa-mode)
* Supports forwarding from the [Google Tag Manager Integration](https://documentation.freshpaint.io/integrations/google-tag-manager-integration)
* Refer to this destination as **LinkedIn Ads Conversions API** in the [Integrations object](https://documentation.freshpaint.io/reference/developer/freshpaint-sdk-reference#using-the-integrations-object)
* Connection Modes:

<table><thead><tr><th width="200.33333333333331" align="right"> </th><th data-type="checkbox">Client-side</th><th data-type="checkbox">Server-side</th></tr></thead><tbody><tr><td align="right">Web</td><td>false</td><td>true</td></tr><tr><td align="right">Mobile</td><td>false</td><td>true</td></tr><tr><td align="right">Server</td><td>false</td><td>true</td></tr></tbody></table>

This is a reference document for the LinkedIn Ads destination. For information on how to set up this integration, see the [linkedin-ads-conversions-api-quick-start-guide](https://documentation.freshpaint.io/integrations/destinations/direct-response-ads/linkedin-ads-conversions-api/linkedin-ads-conversions-api-quick-start-guide "mention").

### Events

When you send an event to the LinkedIn Ads Conversions API destination from Freshpaint, Freshpaint will create an event in the LinkedIn campaign manager by hitting LinkedIn's API.

## Track Events

When you send an event to the LinkedIn Ads Conversions API destination, you can track conversions from your ads based on those events.

Below are the Required, Recommended, and Optional properties which are mapped to the LinkedIn Ads Conversions API request:

<table data-header-hidden data-full-width="true"><thead><tr><th width="165"></th><th width="164"></th><th width="103"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Freshpaint property</strong></td><td><strong>LinkedIn Ads</strong><br><strong>parameter</strong></td><td><strong>Type</strong></td><td><strong>Requirement</strong></td><td><strong>Description</strong></td></tr><tr><td><code>conversion_id</code></td><td><code>conversionId</code></td><td>string</td><td>Required</td><td> A conversion ID provided by LinkedIn that allows you to trigger a specific event.<br><br>The conversion ID will have a similar format to: <code>urn:li:sponsoredAccount:5123456</code></td></tr><tr><td><code>$li_fat_id</code></td><td><code>LINKEDIN_FIRST_PARTY_ADS_TRACKING_UUID</code></td><td>string</td><td>Required [conditional]</td><td>A query parameter that connects a page view or conversion event to a specific ad, which Freshpaint captures as <code>$li_fat_id</code>.<br><br>At least one of <code>$li_fat_id</code>, <code>email</code>, <code>acxiom_id</code>, or <code>oracle_moat_id</code> are required.</td></tr><tr><td><code>email</code></td><td><code>SHA256_EMAIL</code></td><td>string</td><td>Required [conditional]</td><td>Email hashed with SHA 256 algorithm. Used to improve match rates.<br><br><strong>Use with caution. LinkedIn will be able to match hashes with original emails if the emails are recorded in their system.</strong> <br><br>At least one of <code>$li_fat_id</code>, <code>email</code>, <code>acxiom_id</code>, or <code>oracle_moat_id</code> are required.</td></tr><tr><td><code>acxiom_id</code></td><td><code>ACXIOM_ID</code></td><td>string</td><td>Required [conditional]</td><td>User identifier for matching with LiveRamp identity graph. Used for view-through conversions.<br><br>At least one of <code>$li_fat_id</code>, <code>email</code>, <code>acxiom_id</code>, or <code>oracle_moat_id</code> are required.</td></tr><tr><td><code>oracle_moat_id</code></td><td><code>ORACLE_MOAT_ID</code></td><td>string</td><td>Required [conditional]</td><td>User identifier for matching with Oracle MOAT Identity. Used for view-through conversions.<br><br>At least one of <code>$li_fat_id</code>, <code>email</code>, <code>acxiom_id</code>, or <code>oracle_moat_id</code> are required.</td></tr><tr><td><code>currency_code</code></td><td><code>currencyCode</code></td><td>string</td><td>Optional</td><td>Currency code in ISO format (e.g. "USD")<br><br>Must be provided with <code>amount</code></td></tr><tr><td><code>amount</code></td><td><code>amount</code></td><td>string</td><td>Optional</td><td>Monetary amount as a decimal string (e.g. "50.0")<br><br>Must be provided with <code>currency_code</code>.</td></tr><tr><td><code>first_name</code></td><td><code>first_name</code></td><td>string</td><td>Optional</td><td>User's first name. Can improve match rates.<br><br><strong>Unmasked PII. Use with caution.</strong></td></tr><tr><td><code>last_name</code></td><td><code>last_name</code></td><td>string</td><td>Optional</td><td>User's last name. Can improve match rates.<br><br><strong>Unmasked PII. Use with caution.</strong></td></tr><tr><td><code>job_title</code></td><td><code>title</code></td><td>string</td><td>Optional</td><td>User's job title. Can improve match rates.<br><br><strong>Unmasked PII. Use with caution.</strong></td></tr><tr><td><code>company_name</code></td><td><code>company_name</code></td><td>string</td><td>Optional</td><td>User's company name. Can improve match rates.<br><br><strong>Unmasked PII. Use with caution.</strong></td></tr><tr><td><code>country_code</code></td><td><code>country_code</code></td><td>string</td><td>Optional</td><td>User's country code. Can improve match rates.<br><br><strong>Unmasked PII. Use with caution.</strong></td></tr></tbody></table>
