Partager via

Getting Access to Lead Sync API

  • Article

Warning

Deprecation Notice
The Marketing Version 202311 (Marketing November 2023) and earlier versions (excluding 202306 and 202307) have been sunset. Additionally, the unversioned APIs will be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management 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.

The Lead Sync API makes it easy for your customers to automatically collect and sync leads to your platform – saving them time and enabling their sales teams to act on them in real-time. The new API provides access to leads for all marketing use cases, including ads and events as well as the capability to map custom field names to your CRM.

Supported Use Cases

  • Lead Sync: Sync leads directly to a destination such as a marketing automation platform, CRM, or CDP.
  • Reporting: Connect leads with sales data to understand if a lead translated to a purchase.
  • Notification: Create real-time notifications to inform sales of new leads for immediate follow-up.

You will have access to the following permissions:

  • Lead Sync: APIs to retrieve lead gen forms and form response (lead) data. Permission required is r_marketing_leadgen_automation.
  • Events: The APIs that retrieve your organization's events. Permission required is r_events.
  • Page Access: APIs to find organizations and organizations' administrators and access control details by roles. Permission required is r_organization_admin. This permission is only available from LinkedIn-Version: 202210 or later
  • Account Structure: APIs to retrieve information across sponsored accounts, campaign groups, campaigns, and creatives. Permission required is r_ads.
  • Lite profile information: APIs to retrieve the name and photo of the authenticated user. Permission required is r_liteprofile.

If you want to create and manage LinkedIn Lead Gen Forms, you should request access to the Advertising API and use the lead syncing endpoints available within the rw_ads permission to create a Lead Gen Form.

Applying for Lead Sync API Access

Prerequisite

  • Company Page Verification: Company page verification is one of the prerequisites for a developer application applying for access to a product. Do not use a fake company page.
  • Read the LinkedIn Marketing API Terms and developer documentation.
  • Ensure your use case is supported.
  • Be prepared to share your business email address and your organization’s legal name, registered address, website. Your business email address will have to be verified. If you don’t receive the verification email, be sure to check your email's spam folder, junk folder, social tab, and promotional tab. Personal email addresses will not pass the review process.
  • Company Page Verification is required for a developer application applying for access to API. Ensure that you are not using a fake or test company page.
  • Ensure that a super admin of the LinkedIn Page associated with your organization has verified your developer application.
  • Ensure that your application does not include any portion of the LinkedIn or Microsoft names or logos (e.g. Linked or In).
  • Ensure that you have filled out all required fields in the access request form accurately and completely.

Important

Any failure to meet the above prerequisites will result in your access request being rejected.

Apply for Access

  1. Login to Developer Portal with your LinkedIn account
  2. Choose your developer app from My Apps.

    Note

    If you or your organization does not have an existing developer app, create a new developer application.

  3. Navigate to the Products tab under your App name.
  4. From the list of Additional available products, search for the Lead Sync API product and select Request Access.
  5. Submit the form for LinkedIn to review your application.

Review Process

Once you have submitted the access request form, it will be reviewed by LinkedIn for the following:

  • Verified business email address
  • Verified organization
  • Verified organization website and domain address
  • Application verified by LinkedIn Page associated with same organization
  • Approved use case
  • Compliance with our terms, restrictions, and security, privacy, and trust requirements.

Next Steps

If your application is approved, you will be notified over email about your access to the Lead Sync API and your developer application will be provisioned with the required permission.

If your application is denied due to identity vetting failure, for example, when we were unable to verify that your organization is a legally registered active entity, you will see an option to appeal for it from your developer portal application products, when you click on the Access denied link next to Lead Sync API product. Please reach out via a Zendesk ticket.

If your application is rejected, for example, when your access request form provided insufficient details to approve your request, review the Prerequisites and Review Process to ensure your application is in compliance, and if you do not see any option to appeal for it, then you may create a new developer application, and submit a new access request form. You will not be able to re-apply for access with the previously used developer app. Please see the Developer application review status definitions for details about each status and rejection message.

Please note that even if LinkedIn approves your integration, you are solely responsible for ensuring that your integration (including all use, disclosure, and storage of LinkedIn data) is, at all times, in compliance with: (a) the LinkedIn Marketing API Terms and the LinkedIn developer documentation; and (b) all other requirements or restrictions that LinkedIn separately communicates to you (e.g. during or after the review process). LinkedIn retains the right to monitor your application and suspend or discontinue access to the Lead Sync API for any non-compliance with the LinkedIn Marketing API Terms, even if your application was previously approved by LinkedIn.

If you have additional questions or concerns, please reach out via a Zendesk ticket.