Integration Requirements for Audiences
Warning
Deprecation Notice
The Marketing version 202209 (Marketing September 2022) and below has been sunset and the unversioned APIs are going to 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.
LinkedIn is in the process of rolling out a Technical Sign Off process for the Audiences program. This ensures that our members get the best experience whether using LinkedIn's native UI or a partner product. The technical review and sign off also ensures that there are no gaps in integrations and that partner products keep up with the latest features and updates released by LinkedIn.
As an API partner, please go through the requirements listed below. These are the capabilities that an integrating partner is expected to build in their product. We request you to plan and incorporate these features early in your design. When you are nearing completion, you must initiate a Technical Sign Off request by contacting your LinkedIn POC on the Business Development team.
A Demo will be scheduled during which you will be asked to showcase all your product capabilities. During this evaluation, LinkedIn may suggest modifications which will need to be completed for the sign off. If all criteria are met (as per the envisioned scope), the technical sign-off is awarded.
Note
You can begin sharing your product with your Beta customers only after receiving the sign off.
Requirements
Rule | API capabilities to be demonstrated in Demo |
---|---|
Basics | |
MA-001 | Demonstrate OAuth 2.0 integration with right scopes and consent screen. |
MA-002 | Demonstrate ability to periodically verify that an access token is valid (heartbeat /me). |
MA-003 | Demonstrate ability to detect access token expiry. |
MA-004 | Demonstrate ability to re-trigger OAuth Flow in case token has expired or been invalidated. |
MA-005 | Demonstrate ability to use refresh tokens to mint new access tokens. |
MA-006 | Demonstrate ability to detect refresh token expiry and re-trigger OAuth Flow. |
Core | |
MA-101 | Demonstrate ability to retrieve all Sponsored Accounts (ad accounts) with status for the logged in user. |
MA-102 | Demonstrate ability to read all available audiences uploaded by your platform per sponsored account (ad account). |
MA-103 | Demonstrate ability to read status of all uploaded audience segments. |
MA-104 | Demonstrate ability to read match rate, estimated audience size and display readiness of a segment. |
Contact/users match | |
MA-105 | Demonstrate ability to create dynamic audience segments for users (hashed email addresses or MAID). |
MA-106 | Demonstrate ability to Add/Remove a single user (or multiple users) from dynamic audience segments. |
MA-107 | Support additional fields such as first name, last name, Region, etc. |
Company match | |
MA-105 | Demonstrate ability to create dynamic audience segments for companies. |
MA-106 | Demonstrate ability to Add/Remove a single company (or multiple companies) from dynamic audience segments. |
MA-107 | Support additional fields for company matching country/region, stock symbol, etc. |
Advanced implementation - nice to have | |
MA-201 | Support lookalike audiences. |
Feedback
Submit and view feedback for