Manage social and ads.
Authentication
This connector uses OAuth 2.0 authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 331 actions:
| Action | Purpose | Parameters |
|---|---|---|
| ads_transparency_api/get_rest_advertiser_transparency_data_urn_3ali_3asponsored_account_3aby_sponsoredaccount_id | Advertiser Transparency Data | sponsoredaccount_id (string) required month (string) |
| apply_connect/post_v2_provisioned_applications | Provision Customer Application | data (object) required |
| apply_connect/post_v2_ats_integrations | Sync Customer Integrations | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) data: { . entities (object) } (object) required |
| apply_connect/get_v2_provisioned_applications | Get App by uniqueForeignID | q (string) uniqueForeignId (string) |
| apply_connect/get_v2_ats_integrations | Verify Integrations | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) |
| apply_connect/post_v2_simple_job_postings | Sync Jobs | data (object) required |
| apply_connect/post_v2_simple_job_posting_tasks | Check Job Operation Task Status | No parameters |
| apply_connect/post_v2_job_posting_status | Check Job Posting Status | No parameters |
| apply_connect/get_ambry | Get Resume/Cover Letter | x-li-ambry-ep (string) |
| apply_connect/post_v2_job_application_lifecycle_actions | Sync Job Application Feedback Signals | data (object) required |
| apply_with_linkedin_v3/post_oauth_v2_access_token | Child Application Access Token | No parameters |
| apply_with_linkedin_v3/post_v2_ats_integrations | Update Customer ATSIntegration - APPLY_WITH_LINKEDIN | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) data: { . entities (object) } (object) required |
| apply_with_linkedin_v3/get_v2_ats_integrations | Verify Customer Integrations | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) |
| audience_insights/get_ad_targeting_facets | Get a list of available Ad Targeting Facets | No parameters |
| audience_insights/get_ad_targeting_entities | Get all seniorities | q (string) queryVersion (string) facet (string) fields (string) |
| audience_insights/post_targeting_audience_insights | What are the top Job Functions among members with Product Management skills in NY? | action (string) data: { . request (object) } (object) required |
| audiences/get_ad_accounts | 2. Retrieve the user's Ad Accounts sponsoredAccount | q (string) search (string) fields (string) |
| audiences/get_dmp_segments | The api call fetches all DMP segments for a specific ad accounthttps://docs.microsoft.com/linkedin/marketing/integrations/matched-audiences/create-and-manage-segments?tabs=http find-dmp-segments-by-account and your designated sourcePlatform ENUM. Display match rate, audience size, and segment status to the user. Match Rate is calculated by rounding matchedCount / inputCount. Review our online documentation for more information on audienceSize vs matchedCounthttps://docs.microsoft.com/linkedin/m | q (string) account (string) sourcePlatform (string) |
| audiences/post_dmp_segments | This call creates a DMP segmenthttps://docs.microsoft.com/linkedin/marketing/integrations/matched-audiences/create-and-manage-segments?tabs=http create-dmp-segment named 'DMP Segment 1' tied to the sponsored account the user chose in step 2. The sourcePlatform is an ENUM value that is provided by your LinkedIn contact after you have been granted access to the Audience APIs. NOTE: there must be at least a 5 second delay between step 2 creating the segment and step 3 streaming company data or th | data: { . name (string) . sourcePlatform (string) . account (string) . type (string) . destinations (array) } (object) required |
| audiences/post_dmp_segments_by_company_segment_id_companies | This example adds multiple companies to the DMP segment created in step 2. To see what other fields can also be added/removed, review the schema sectionhttps://docs.microsoft.com/linkedin/marketing/integrations/matched-audiences/create-and-manage-segment-companies?tabs=http add-or-remove-a-company of our online documentation. The more information on a company that is provided, the better chance of a higher match rate. | company_segment_id (string) required data: { . elements (array) } (object) required |
| audiences/post_dmp_segments_by_user_segment_id_users | This example adds multiple users to the DMP segment created in step 2. To see what other fields can also be added/removed, review the schema sectionhttps://docs.microsoft.com/linkedin/marketing/integrations/matched-audiences/create-and-manage-segment-users?tabs=http add-or-remove-a-user of our online documentation. The more information on a user that is provided, the better chance of a higher match rate. | user_segment_id (string) required data: { . elements (array) } (object) required |
| audiences/post_dmp_segments_by_pa_dmp_segment_id_business_objective_based_audiences | This example created a predictive audience within the DMP segment created in step 2. | pa_dmp_segment_id (string) required data: { . targetingFilter (object) . desiredAudienceCount (integer) . seeds (array) } (object) required |
| audiences/get_dmp_segments_by_pa_dmp_segment_id_business_objective_based_audiences_by_predictive_audience_id | 4. Retrieve the Predictive Audience | pa_dmp_segment_id (string) required predictive_audience_id (string) required |
| audiences/post_dmp_segments_by_listupload_segment_id_list_uploads | This call attaches the uploaded CSV list file using the media URN returned in step 5 to the DMP segment created in step 6. For more detail on attaching an uploaded list to a DMP segmenthttps://docs.microsoft.com/linkedin/marketing/integrations/matched-audiences/create-and-manage-list-uploads?tabs=http attach-list-to-dmp-segment, see our online documentation. | listupload_segment_id (string) required data: { . inputFile (string) } (object) required |
| campaign_management/put_ad_account_users_account_urn_3ali_3asponsored_account_3aby_sponsoredaccount_id_user_urn_3ali_3aperson_3aby_person_id_ | This API example creates an Ad Account Userhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users?tabs=http create-ad-account-user. Creating Ad Account Users grants a member access to an Ad Account. | sponsoredaccount_id (string) required person_id (string) required data: { . account (string) . role (string) . user (string) } (object) required |
| campaign_management/get_ad_account_users_account_urn_3ali_3asponsored_account_3aby_sponsoredaccount_id_user_urn_3ali_3aperson_3aby_person_id_ | This API example fetches an Ad Account Userhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users?tabs=http get-ad-account-user. Fetching an existing Ad Account User requires both account and user parameters. The person id can also be retrieved from the /mehttps://docs.microsoft.com/linkedin/shared/integrations/people/profile-api retrieve-current-members-profile endpoint. | sponsoredaccount_id (string) required person_id (string) required |
| campaign_management/get_ad_account_users | This API example searches for all Ad Account Users by sponsored ad account or multiple sponsored ad accounts. Learn more in our public documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users?tabs=http find-ad-account-users-by-accounts. | q (string) accounts (string) |
| campaign_management/get_organization_acls | To understand more about verifying Company Page Access visit our public documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/community-management/organizations/organization-access-control-by-role?tabs=http find-a-members-organization-access-control-information. A role defines the privileges that a member has within the organization. You must be an authenticated member with role type ADMINISTRATOR of an organization to use many of the Organization APIs. | q (string) |
| campaign_management/post_ad_account_users_account_urn_3ali_3asponsored_account_3aby_sponsoredaccount_id_user_urn_3ali_3aperson_3aby_person_id_ | This API example updates an Ad Account Userhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users?tabs=http update-existing-ad-account-user. An Ad Account User's role can be updated by using this endpoint. | sponsoredaccount_id (string) required person_id (string) required data: { . patch (object) } (object) required |
| campaign_management/delete_ad_account_users_account_urn_3ali_3asponsored_account_3aby_sponsoredaccount_id_user_urn_3ali_3aperson_3aby_person_id_ | This API example deletes an Ad Account Userhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users?tabs=http delete-an-ad-account-user. Members can be removed from Ad Account access by using the delete Ad Account User endpoint. Deletion requires both account and user parameters to look up the appropriate Ad Account User. | sponsoredaccount_id (string) required person_id (string) required |
| campaign_management/post_ad_accounts | This example API creates an Ad Accounthttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?tabs=http create-ad-account | data: { . currency (string) . name (string) . notifiedOnCampaignOptimization (boolean) . notifiedOnCreativeApproval (boolean) . notifiedOnCreativeRejection (boolean) . notifiedOnEndOfCampaign (boolean) . reference (string) . type (string) } (object) required |
| campaign_management/get_ad_accounts_by_sponsoredaccount_id | Fetch an ad Accounthttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?tabs=http fetch-ad-account by sponsored account ID. | sponsoredaccount_id (string) required |
| campaign_management/get_ad_accounts | Use the q=search parameter with the adAccountsV2 API to search for ad accountshttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?tabs=http search-for-accounts by ID, name, reference, type, and status fields. Search criteria can be chained together for increased granularity. If a search query is omitted, all accounts the caller has access to are returned in the response. This example searches for accounts by the StatusDRAFT. | q (string) search (string) |
| campaign_management/post_ad_accounts_by_sponsoredaccount_id | Ad Accounts can be updated through a partial update by patching the fields you want to change. The following example changes the name field only. See our public documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?tabs=http update-ad-account for more information. | sponsoredaccount_id (string) required data: { . patch (object) } (object) required |
| campaign_management/post_ad_accounts_by_ad_accounts_id_ad_campaign_groups | Campaign groups can be created in ACTIVE or DRAFT state. You can change ACTIVE to ARCHIVED or PAUSED. This example creates a Campaign Grouphttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http create-a-campaign-group in the state DRAFT. | adAccountsId (string) required data: { . account (string) . name (string) . runSchedule (object) . status (string) . totalBudget (object) } (object) required |
| campaign_management/get_ad_accounts_by_ad_accounts_id_ad_campaign_groups_by_campaigngroup_id1 | A Campaign Group can be fetched by the campaign group id as shown in this example call. See our public documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http get-a-campaign-group for more information. | adAccountsId (string) required campaigngroup_id1 (string) required |
| campaign_management/get_ad_accounts_by_ad_accounts_id_ad_campaign_groups | Multiple Campaign Groups can be fetched by the campaign group ids a shown in this example call. View our public documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http batch-get-campaign-groups for more information. | adAccountsId (string) required ids (string) |
| campaign_management/post_ad_accounts_by_ad_accounts_id_ad_campaign_groups_by_campaigngroup_id1 | Campaign groups can be updated with a partial update. This example updates the amount and currencyCode for a Campaign Group. View our public documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http update-a-campaign-group to learn more. | adAccountsId (string) required campaigngroup_id1 (string) required data: { . patch (object) } (object) required |
| campaign_management/delete_ad_accounts_by_ad_accounts_id_ad_campaign_groups_by_campaigngroup_id1 | This example call deletes a Campaign Grouphttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http delete-a-campaign-group. Only campaign groups which are in DRAFT status are allowed to be deleted. Once deleted, a campaign group can't be retrieved or recovered. | adAccountsId (string) required campaigngroup_id1 (string) required |
| campaign_management/delete_ad_accounts_by_ad_accounts_id_ad_campaign_groups | Multiple Campaign Group can be deleted as shown in this example call. View our online documentation herehttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http batch-delete-campaign-groups to learn more. Only campaign groups which are in DRAFT status are allowed to be deleted. Once deleted, a campaign group can't be retrieved or recovered. | adAccountsId (string) required ids (string) |
| campaign_management/get_ad_accounts_by_ad_accounts_id_ad_campaigns_by_campaign_id1 | Fetch a Campaign using Campaign ID | adAccountsId (string) required campaignId1 (string) required |
| campaign_management/post_ad_accounts_by_ad_accounts_id_ad_campaigns | Create Campaign SPONSORED_UPDATES | adAccountsId (string) required data: { . account (string) . campaignGroup (string) . audienceExpansionEnabled (boolean) . costType (string) . creativeSelection (string) . dailyBudget (object) . locale (object) . name (string) . offsiteDeliveryEnabled (boolean) . runSchedule (object) . targetingCriteria (object) . type (string) . unitCost (object) . status (string) } (object) required |
| campaign_management/get_ad_accounts_by_ad_accounts_id_ad_campaigns | Search for Campaign using criteria | adAccountsId (string) required q (string) search.campaignGroup.values0 (string) |
| campaign_management/post_ad_accounts_by_ad_accounts_id_ad_campaigns_by_campaign_id1 | Update Campaign Using campaignId | adAccountsId (string) required campaignId1 (string) required data: { . patch (object) } (object) required |
| campaign_management/post_ad_accounts_by_ad_accounts_id_ad_campaigns_by_campaign_id1 | Reactivate a Campaign | adAccountsId (string) required campaign_id1 (string) required data: { . patch (object) } (object) required |
| campaign_management/delete_ad_accounts_by_ad_accounts_id_ad_campaigns_by_campaign_id1 | Delete campaign Using campaign Id | adAccountsId (string) required campaign_id1 (string) required |
| campaign_management/delete_ad_accounts_by_ad_accounts_id_ad_campaigns | Delete multiple campaigns using BATCH | adAccountsId (string) required ids (string) |
| campaign_management/get_ad_accounts_by_ad_accounts_id_creatives_by_creative_id1 | Fetch a Creative using Creative ID | adAccountsId (string) required creative_Id1 (string) required |
| campaign_management/get_ad_accounts_by_ad_accounts_id_creatives | Fetch multiple Creatives using BATCH | adAccountsId (string) required ids (string) |
| campaign_management/post_ad_accounts_by_ad_accounts_id_creatives | Create a Creative | adAccountsId (string) required data: { . campaign (string) . reference (string) . status (string) . type (string) . variables (object) } (object) required |
| campaign_management/post_ad_accounts_by_ad_accounts_id_creatives_by_creative_id1 | Update Creative Using Creative Id | adAccountsId (string) required creative_Id1 (string) required data: { . patch (object) } (object) required |
| campaign_management/delete_ad_accounts_by_ad_accounts_id_creatives_by_creative_id1 | Delete Creative Using Creative Id | adAccountsId (string) required creative_Id1 (string) required |
| campaign_management/delete_ad_accounts_by_ad_accounts_id_creatives | Delete multiple Creatives using BATCH | adAccountsId (string) required ids (string) |
| campaign_management/get_ad_targeting_facets | View our Public Documentationhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/advertising-targeting/ads-targeting?tabs=http and view=li-lms-unversioned to understand more on Ads Targeting APIs. Facets are high-level categories of the types of targeting available to you. Use facets to narrow down your intended audience. The adTargetingFacets API returns available targeting facets. | No parameters |
| campaign_management/get_ad_targeting_entities | To understand more about the Ad Targeting Entities refer to our public documentation herehttps://docs.microsoft.com/linkedin/shared/references/v2/ads/adtargetingentities?context=linkedin/marketing/contex and view=li-lms-unversioned. Once you've identified the facet types you'd like to target, you can fetch their entity values. This API example fetches the Entities by facet Seniorities. | q (string) queryVersion (string) facet (string) locale (string) |
| campaign_management/get_ad_supply_forecasts | The Ad Supply Forecasts API enables you to forecast impressions, spending, and other metrics based on: Targeting criteria Campaign settings such as campaign type and objective type Bid and spending settings Time period | q (string) account (string) timeRange (string) campaignType (string) totalBudget (string) competingBid (string) targetingCriteria (string) |
| campaign_management/post_assets | View our Public Documentationhttps://docs.microsoft.com/linkedin/marketing/integrations/community-management/shares/vector-asset-api?tabs=http and view=li-lms-unversioned register-an-upload-for-images to understand more on this API. This API example covers Registering an upload for an Image File. The returned uploadUrl in the response can then subsequently be used to perform the actual upload in Step 3. | action (string) |
| campaign_management/get_assets_by_asset_id | View our Public Documentationhttps://docs.microsoft.com/linkedin/marketing/integrations/community-management/shares/vector-asset-api?tabs=http and view=li-lms-unversioned check-status-of-upload to understand more on this API. This API examples retrieves the status of the Image File uploaded in the previous step by using the digital media asset ID returned in step 1. The recipe upload status must be 'AVAILABLE' in order to move on to the next step! | asset_id (string) required |
| campaign_management/post_shares | View our Public Documentationhttps://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api?tabs=http and view=li-lms-unversioned post-shares to understand more on creating shares. This API example creates an organic image share on the Company Page organization referencing the Image file that was uploaded in Step 3. | data: { . owner (string) . text (object) . subject (string) . distribution (object) . content (object) } (object) required |
| campaign_management/post_ad_campaigns | View our Public Documentationhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaigns?tabs=http and view=li-lms-unversioned create-a-campaign to understand more on creating a Single Image Sponsored Content Campaign. This API example creates a Sponsored Content Campaign to be used in the next step. | data: { . account (string) . campaignGroup (string) . associatedEntity (string) . audienceExpansionEnabled (boolean) . costType (string) . creativeSelection (string) . dailyBudget (object) . locale (object) . name (string) . offsiteDeliveryEnabled (boolean) . runSchedule (object) . targetingCriteria (object) . type (string) . unitCost (object) . status (string) } (object) required |
| campaign_management/post_ad_creatives | View our Public Documentationhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/account-structure/create-and-manage-creatives?tabs=http and view=li-lms-unversioned create-a-sponsored-content-share to understand more on creating a Sponsored Content Ad Creative. This API example creates a Sponsored Content Ad Creative referencing the previously created image share in step 5. This Creative will be created under the Campaign created in the previous step. | data: { . campaign (string) . reference (string) . status (string) . type (string) . variables (object) } (object) required |
| campaign_management/get_assets_by_video_asset_id | 4. Check the status of the upload | video_asset_id (string) required |
| campaign_management/post_posts | 5. Create Post | data: { . author (string) . lifecycleState (string) . specificContent (object) . visibility (object) } (object) required |
| campaign_management/post_creatives | 7. Create a Creative for the Video Ad | data: { . campaign (string) . reference (string) . status (string) . type (string) . variables (object) } (object) required |
| campaign_management/post_documents | 2. Register Document Upload | action (string) |
| campaign_management/get_assets_by_document_asset_id | 4. Check the status of the upload | document_asset_id (string) required |
| campaign_management/get_audience_counts | View our Public Documentationhttps://docs.microsoft.com/linkedin/marketing/integrations/ads/advertising-targeting/ads-targeting?tabs=http and view=li-lms-unversioned to understand more on Ads Targeting APIs. Facets are high-level categories of the types of targeting available to you. Use facets to narrow down your intended audience. The adTargetingFacets API returns available targeting facets. | q (string) targetingCriteria (string) |
| company_intelligence_api/get_ad_account_users | Fetch all ad accounts of the authenticated user | q (string) |
| company_intelligence_api/get_ad_accounts_by_ad_accounts_id_ad_campaigns | Search for campaigns using search criteria | adAccountsId (string) required q (string) search.campaignGroup.values0 (string) |
| company_intelligence_api/get_ad_segments | Fetch existing ad segments based on ad account | q (string) accounts (string) |
| company_intelligence_api/get_account_intelligence | Fetch account intelligence data using lookback window filter | q (string) start (string) count (string) account (string) filterCriteria (string) |
| compliance_events/post_v2_member_compliance_authorizations | Opt in a member to be regulated | data: { } (object) required |
| compliance_events/get_v2_member_compliance_authorizations | Check a member's regulation status | q (string) |
| compliance_events/delete_v2_member_compliance_authorizations_developer_application_urn_li_developer_application_by_developer_application_id_member_urn_li_person_by_person_id | Opt out a member from being regulated on LinkedIn. Note: A member will not opt out of Compliance authorization due to access token expiration. The only ways an opt out can happen are: Application invokes the DELETE API mentioned above The regulated member removes the application's authorization through LinkedIn's Privacy Setting page. This can be found under the Third Parties sectionhttps://www.linkedin.com/psettings/permitted-services. To know more, please referhttps://docs.microsoft.com/e | developer_application_id (string) required person_id (string) required |
| compliance_events/get_v2_compliance_events | Once the member has authorized to be regulated, the compliance events for the member can be retrieved using the /v2/complianceEvents API. To know more on the response schema, refer herehttps://docs.microsoft.com/en-us/linkedin/compliance/integrations/compliance-events/?context=linkedin/compliance/context compliance-events-schema. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/compliance/integrations/compliance-events/?context=linkedin/compliance/context compliance-ev | q (string) projection (string) startTime (string) count (string) |
| content_apis/post_rest_in_mail_contents | API to create an inMail Content. | data (object) required |
| content_apis/get_rest_in_mail_contents_by_ad_in_mail_content_id | API to retrieve an inMail Content. | adInMailContentId (string) required |
| content_apis/post_rest_in_mail_contents_by_ad_in_mail_content_id | API to update an inMail Content. | adInMailContentId (string) required data: { . patch (object) } (object) required |
| content_apis/get_rest_in_mail_contents | API to retrieve an inMail Content in Batches. | ids (string) |
| content_apis/post_images | Use the initializeUpload action to register the upload. When you initialize, you declare the upcoming upload. Use the upload URL to upload the image. | action (string) data: { . initializeUploadRequest (object) } (object) required |
| content_apis/get_rest_images_by_image_urn | This API rerieve a single image. | image_urn (string) required |
| content_apis/get_rest_images | This API rerieve multiple images. | ids (string) |
| content_apis/get_rest_posts | This API creates an image content. | data: { . author (string) . commentary (string) . visibility (string) . distribution (object) . content (object) . lifecycleState (string) . isReshareDisabledByAuthor (boolean) } (object) required |
| content_apis/get_rest_posts_by_post_id | This API rerieve the content associated with a single image. | postId (string) required |
| content_apis/post_videos | Use the initializeUpload action to register the upload. When you initialize, you declare the upcoming upload. Use the upload URL from the uploadInstructions to upload the video. | action (string) data: { . initializeUploadRequest (object) } (object) required |
| content_apis/get_images_by_image_urn | This API retrieves a single video. | image_urn (string) required |
| content_apis/get_images | This API retrieves multiple videos. | ids (string) |
| content_apis/post_creatives | You can sponsor an existing organic post that has been serving your company page followers and gone viral. | data: { . content (object) . campaign (string) . intendedStatus (string) } (object) required |
| content_apis/get_creatives_by_urn_creatives | Get a Sponsored Creative | urn_creatives (string) required |
| content_apis/get_creatives | You can search for creative content in order to get a collection of creatives matching your search parameters. The Creative API currently supports search by creative id, campaign, account, content reference, intendedStatus, leadgenCreativeCallToActionDestinations and test fields. The API supports finding creatives from multiple accounts. The values within each field are displayed with 'or' ORed and values across fields are displayed with 'and' ANDed. | accounts (string) campaigns (string) contentReferences (string) creatives (string) intendedStatuses (string) isTestAccount (string) isTotalIncluded (string) leadgenCreativeCallToActionDestinations (string) q (string) sortOrder (string) |
| content_apis/post_creatives_by_creative_id | You can change the details of following Creatives fields: intendedStatus: leadgenCallToAction: field adFormUrn - The ad form that is a target destination for the callToAction button. It can only be modified when the creative is in DRAFT status. It is read only once it is set for a creative and once it transitions to any non-draft intended status. leadgenCallToAction: field label -Label for the callToAction button This API updates a sponsored creative. | creative ID (string) required |
| content_apis/delete_creatives_by_creative_id | A Creative can be deleted. Use DELETE method to delete a creative that meets one of the following conditions. To start the process of deleting other creative, update the status to PENDING_DELETION. It is in a DRAFT state. It is linked to a Campaign in a DRAFT state. It is a video ad creative and processingState is PROCESSING_FAILED. The header X-RestLi-Method must be included in the request and set to DELETE. | creative ID (string) required |
| content_apis/post_posts | Simplest form of post creation where an organic post is made ith a sample text at a page. | data: { . author (string) . commentary (string) . visibility (string) . distribution (object) . content (object) . lifecycleState (string) . isReshareDisabledByAuthor (boolean) } (object) required |
| content_apis/get_posts_by_encoded_ugc_post_urn_share_urn | Creating posts with image requires uploading an image asset to obtain a Image URN urn:li:image:id for creating the post. See the Images APIhttps://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2022-08 for instructions on how to do this. | encoded ugcPostUrn|shareUrn (string) required |
| content_apis/get_posts | Multiple posts can be retrieved and viewed in a single API call by passing in multiple UGC Posts or share URNs into the ids parameter. The UGC Post URNs should be passed in List format and should be encoded as shown in the examples below. Note that the , in the List separating each URN does not need to be encoded. | ids (string) |
| content_apis/post_posts_by_shared_id_by_ugc_posts_id | The following posts field are available to update. Refer to Schemahttps://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/posts-api?view=li-lms-2022-08 and tabs=http post-schema for complete field details. | Field | Description | | --- | --- | | commentary | String | | contentCallToActionLabel | contentCallToActionLabel text | | contentLandingPage | URL of the landing page | | reshareContext | | | lifecycleState | | | adContext | dscName: Update the nam | shared ID (string) required ugcPosts ID (string) required data: { . patch (object) } (object) required |
| content_apis/delete_posts_by_encoded_ugc_post_urn_share_urn | Post deletions are idempotent. Deletion requests for a previously deleted UGC Post will return a 204 code - No Content. | encoded ugcPostUrn|shareUrn (string) required |
| content_apis/post_conversation_ads | Successful response will have Status 201 Created and the ID in the x-linkedin-id response header. For example,urn:li:sponsoredConversation:164380864 | No parameters |
| content_apis/get_conversation_ads_by_conversation_urn | Sample Response JSONCopy 'id': 'urn:li:sponsoredConversation:185204', 'parentAccount': 'urn:li:sponsoredAccount:520866471' | conversationUrn (string) required |
| content_apis/get_conversation_ads | Makes a BATCH_GET request to let a list of conversations that are created. Sample Response JSONCopy 'statuses': 'urn:li:sponsoredConversation:704255': 200, 'urn:li:sponsoredConversation:703695': 200 , 'results': 'urn:li:sponsoredConversation:704255': 'id': 'urn:li:sponsoredConversation:704255', 'parentAccount': 'urn:li:sponsoredAccount:520866471' , 'urn:li:sponsoredConversation:703695' | ids (string) |
| content_apis/post_conversation_ads_by_conversation_urn | In the following example, the firstMessageContent field is changed to point to the first message of the conversation. | conversationUrn (string) required data (object) required |
| content_apis/post_conversation_ads_by_conversation_ads_id_sponsored_message_contents | A successful response returns a 201 Created HTTP status code and the ID in the x-linkedin-id response header, e.g. 'urn:li:sponsoredMessageContent:urn:li:sponsoredConversation:186604,14277'. | conversationAdsId (string) required data: { . bodySource (object) } (object) required |
| content_apis/get_conversation_ads_by_conversation_urn_sponsored_message_contents_by_message_urn | Retrieves just a single message content from all the conversations in a conversation Ad. | conversationUrn (string) required messageUrn (string) required |
| content_apis/get_conversation_ads_by_conversation_urn_sponsored_message_contents | Retrieves just all the message contents from all the conversations in a conversation Ad. | conversationUrn (string) required |
| content_apis/post_conversation_ads_by_conversation_urn_sponsored_message_contents_by_message_urn | Updates the message contents from all the conversations in a conversation Ad. | conversationUrn (string) required messageUrn (string) required data (object) required |
| content_apis/post_conversation_ads_by_conversation_urn_sponsored_message_contents | Updates Sponsored Message Content in Batches. | conversationUrn (string) required ids (string) data (object) required |
| content_apis/delete_conversation_ads_by_conversation_urn_sponsored_message_contents | Deletes Sponsored Message Content in Batches. | conversationUrn (string) required ids (string) |
| content_apis/get_creatives_by_sponsored_creative_urn | Retrieves a dynamic follower ad after passing an urn. A successful response returns a HTTP 200 status code. | sponsoredCreative_urn (string) required |
| content_apis/post_creatives_by_sponsored_creative_urn | Updates a dynamic follower ad after passing an urn. A successful response returns a 204 No Content HTTP status code. | sponsoredCreative_urn (string) required data: { . patch (object) } (object) required |
| content_apis/delete_creatives_by_sponsored_creative_urn | Updates a dynamic follower ad after passing an urn. A successful response returns a 204 No Content. | sponsoredCreative_urn (string) required |
| content_apis/post_documents | Initialize Document Upload | action (string) |
| content_apis/get_documents_by_document_asset_id | Get a single document | document_asset_id (string) required |
| conversions_api/get_ad_account_users | 2. Retrieve authenticated user's Sponsored Ad Accounts | q (string) fields (string) |
| conversions_api/get_conversions | Fetch existing conversion rules in the selected ad account with this endpoint and parse the response to filter elements with conversionMethod to CONVERSIONS_API for streaming conversions through API. | q (string) account (string) fields (string) |
| conversions_api/post_conversions | Create one or more conversion rules with this endpoint and set conversionMethod to CONVERSIONS_API for streaming conversions through API. | autoAssociationType (string) data: { . name (string) . account (string) . conversionMethod (string) . postClickAttributionWindowSize (integer) . viewThroughAttributionWindowSize (integer) . attributionType (string) . type (string) } (object) required |
| conversions_api/get_ad_accounts_by_sponsoredaccount_id_ad_campaigns | Fetch existing conversion rules in the selected ad account with this endpoint and parse the response to filter elements with conversionMethod to CONVERSIONS_API for streaming conversions through API. | sponsoredaccount_id (string) required q (string) search (string) fields (string) |
| conversions_api/put_campaign_conversions_campaign_urn_3ali_3asponsored_campaign_3aby_campaign_id_conversion_urn_3alla_3alla_partner_conversion_3aby_conversion_id_ | Create one or more conversion rules with this endpoint and set conversionMethod to CONVERSIONS_API for streaming conversions through API. | campaign_id (string) required conversion_id (string) required data: { . campaign (string) . conversion (string) } (object) required |
| conversions_api/put_campaign_conversions | Create one or more conversion rules with this endpoint and set conversionMethod to CONVERSIONS_API for streaming conversions through API. | ids (string) data: { . entities (object) } (object) required |
| conversions_api/post_conversion_events | Create one or more conversion rules with this endpoint and set conversionMethod to CONVERSIONS_API for streaming conversions through API. | data: { . conversion (string) . conversionHappenedAt (integer) . conversionValue (object) . user (object) . eventId (string) } (object) required |
| events_management_api/get_organization_acls | Find a Member's Organization Access Control | q (string) |
| events_management_api/get_events_by_id | Get Event by ID | id (string) required |
| events_management_api/get_events | Find Events by Organizer | q (string) organizer (string) start (string) count (string) excludeCancelled (string) timeBasedFilter (string) entryCriteria (string) sortOrder (string) |
| events_management_api/post_events | Create Organization Owned Event | data (object) required |
| job_posting/post_v2_simple_job_postings | By using this API, Customer can create BASIC Jobs. To know more please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/job-postings/api/job-posting-api-schema foundation-schema | data (object) required |
| job_posting/get_v2_simple_job_posting_tasks | /SimpleJobPostingTasks used to track the Status of Jobs. To learn more please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/job-postings/api/check-job-taskstatus To test and view the Jobs that you successfully posted , use https://www.linkedin.com/jobs/view/ jobPosting ID jobPosting ID can be get from the response of /SimpleJobpostingtask eg:https://www.linkedin.com/jobs/view/2635675045 | ids (string) |
| job_posting/post_v2_ats_integrations | Update Customer Integrations | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) data: { . entities (object) } (object) required |
| job_posting/get_v2_ats_integrations | Check Customer Integration | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) |
| lead_sync/get_organization_acls | In this step, you'll retrieve a list of all the organizations that the logged in user has an approved role for. The authenticated user must have one of the roles mentioned in our permissionshttps://learn.microsoft.com/en-us/linkedin/marketing/integrations/lead-sync/leadsync?tabs=http permissions table to successfully sync leads note this may be different depending on the lead type chosen in the previous step. Additional information on this API is available on the Organization Access Control pag | q (string) state (string) count (string) start (string) |
| lead_sync/get_lead_forms | At this point, the user has picked the organization compnay page they are trying to collect leads for and you've validated they have the proper company page role. This step will retrieve the forms associated with the selected organization. --- 5. Map Lead Gen Form fields to destination fields Using the API response data from the previous step, your application should ask the user to map questions, consents, and hidden fields to the appropriate fields in the destination system e.g. a CRM. All | owner (string) q (string) count (string) start (string) |
| lead_sync/get_lead_form_responses | This example pulls back all form responses leads for the chosen organization for a given lead type. It also uses field projectionhttps://learn.microsoft.com/en-us/linkedin/shared/api-guide/concepts/projections?context=linkedin/marketing/context to pull back specific fields in the response and the submittedAtTimeRange field to pull back leads up to 365 days in the past. To pull back leads for other lead types make an additional API call with the appropriate lead type https://learn.microsoft.com/e | q (string) owner (string) leadType (string) limitedToTestLeads (string) submittedAtTimeRange (string) fields (string) count (string) start (string) |
| lead_sync/post_lead_notifications | This is our recommended back practice with a pull backup. Register a lead notification webhookhttps://learn.microsoft.com/en-us/linkedin/marketing/integrations/lead-sync/leadsync?tabs=http lead-notification-subscriptions to receive notifications for new leads. Lead notifications can also be subscribed at a more granular level and/or for a different lead type - see the linked documentation. This example registers the webhook url, https://www.example.comhttps://www.example.com/, at the organizati | data (object) required |
| lead_sync/get_lead_form_responses_by_lead_id | Responses can be fetchedhttps://learn.microsoft.com/en-us/linkedin/marketing/integrations/lead-sync/leadsync?tabs=http get-lead-sync-form-responses for a single form response, multiple form responses, or at the Organization level. When a lead notification event is received, the form response id exists in the lead notification contenthttps://learn.microsoft.com/en-us/linkedin/marketing/integrations/lead-sync/leadsync?tabs=http example-payload-for-when-a-member-registers-for-an-event. This examp | lead_id (string) required fields (string) |
| lead_sync/delete_leadnotifications_by_webhook_id | Delete a lead notification subsriptionhttps://learn.microsoft.com/en-us/linkedin/marketing/integrations/lead-sync/leadsync?tabs=http delete-lead-notification-url When an integration is deleted within your platform, the associated webhooks should also be deleted to ensure that lead notifications are not unnecessarily being sent. | webhook id (string) required |
| lead_sync/get_ad_accounts | View Search for Accountshttps://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?tabs=http search-for-accounts documentation for more information. This API call pulls back Ad Accounts that the member has access to where the status = ACTIVE and test = false NOT a test Ad Account. Learn more about Test Ad Accounts herehttps://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?tabs=http | q (string) search (string) fields (string) count (string) start (string) |
| learning_activity_reports/get_v2_learning_activity_reports | Learning Activity Reports API This resource represents LinkedIn Learning activity reports like course completions, seconds of content viewed and learner logins. You can use these methods to aggregate activity data by account, group, individual or content. Documentation: https://docs.microsoft.com/en-us/linkedin/learning/reference/learning-activity-reports-reference definitionshttps://docs.microsoft.com/en-us/linkedin/learning/reference/learning-activity-reports-reference definitionsParameters | q (string) count (string) startedAt (string) timeOffset.unit (string) timeOffset.duration (string) aggregationCriteria.primary (string) contentSource (string) locale.language (string) |
| learning_content/get_v2_learning_assets_by_asset_urn | To retrieve an individual learning asset, given an URN, issue a GET request to the following endpoint: GET https://api.linkedin.com/v2/learningAssets/URN The URN types supported by this endpoint are 'urn:li:lyndaCourse', 'urn:li:lyndaChapter', and 'urn:li:lyndaVideo'. Documentation: https://docs.microsoft.com/en-us/linkedin/learning/integrations/retrieve-an-individual-learning-object learningassets-get Access to LinkedIn Learning APIs is available to members of our Partner Programhttps://lea | asset_urn (string) required |
| learning_content/get_v2_learning_assets | This finder can be used to retrieve a page of learning assets, given some set of criteria. Using this endpoint you can: Search for learning assets given some search and relevance criteria. Retrieve a list of learning assets released, retired or modified since a given date. Retrieve a list of learning assets the requester is licensed to access. GET https://api.linkedin.com/v2/learningAssets?q=criteriahttps://api.linkedin.com/v2/learningAssets?q=criteria Documentation: https://docs.microsof | q (string) assetFilteringCriteria.assetTypes0 (string) assetFilteringCriteria.licensedOnly (string) |
| learning_content/get_v2_learning_classifications | To retrieve a page of learning classifications, given some criteria, issue a GET call to the following endpoint: GET https://api.linkedin.com/v2/learningClassifications?q=localeAndType Documentation: https://docs.microsoft.com/en-us/linkedin/learning/integrations/locale-and-type-api learningclassifications-localeandtype-finder Access to LinkedIn Learning APIs is available to members of our Partner Programhttps://learning.linkedin.com/partners and organizations that have purchased LinkedIn Lear | q (string) type (string) sourceLocale.language (string) sourceLocale.country (string) |
| learning_content/get_v2_learning_classifications_by_category_urn | To retrieve an individual learning classification, given an URN, issue a GET request to the following endpoint: GET https://api.linkedin.com/v2/learningClassifications/URN The URN types supported by this endpoint are 'urn:li:lyndaCategory' and 'urn:li:skill'. Documentation: https://docs.microsoft.com/en-us/linkedin/learning/integrations/retrieve-an-individual-learning-object learningclassifications-get Access to LinkedIn Learning APIs is available to members of our Partner Programhttps://lear | category_urn (string) required |
| linkedin_live_events/get_v2_me | /me get | No parameters |
| linkedin_live_events/get_v2_content_access_entity_member_urn_3ali_3aperson_3aby_abcde_feature_type_live_video_ | /contentAccess | abcde (string) required |
| linkedin_live_events/post_v2_live_asset_actions | /liveAssetActions register | action (string) data: { . registerLiveEventRequest (object) } (object) required |
| linkedin_live_events/get_v2_assets_by_abcde12345 | /assets?projection=recipes get Copy | abcde12345 (string) required projection (string) |
| linkedin_live_events/post_v2_ugc_posts | create ugcPosts live video | data: { . author (string) . lifecycleState (string) . specificContent (object) . visibility (object) } (object) required |
| linkedin_live_events/get_v2_organization_acls | /organizationAcls | q (string) projection (string) |
| linkedin_live_events/get_v2_content_access_entity_company_urn_3ali_3aorganization_3aby_12345_admin_member_urn_3ali_3aperson_3aby_abcde_feature_type_live_video_ | /contentAccess | 12345 (string) required abcde (string) required |
| linkedin_live_events/get_v2_live_videos | /liveVideos?q=author | q (string) author (string) |
| linkedin_live_events/post_v2_assets | /assets optional announcement image | action (string) data: { . registerUploadRequest (object) } (object) required |
| linkedin_live_events/post_v2_live_videos | /liveVideos | data: { . author (object) . scheduledAt (integer) . announcementImage (object) . name (string) } (object) required |
| linkedin_live_events/post_v2_live_videos_by_123456789 | /liveVideos | 123456789 (string) required data: { . patch (object) } (object) required |
| lms_api_siteup/get_ad_account_users | Fetch the Authenticated User's Ad Accounts | q (string) |
| lms_api_siteup/get_organization_acls | Fetch the Authenticated User's Organization Roles | q (string) |
| lms_api_siteup/get_ad_accounts_by_sponsoredaccount_id | Fetch the Ad Account by ID | sponsoredaccount_id (string) required |
| media_planning/get_ad_targeting_facets | Get a list of available Ad Targeting Facets | No parameters |
| media_planning/get_ad_targeting_entities | Get all seniorities | q (string) queryVersion (string) facet (string) fields (string) |
| media_planning/post_media_planning | Forecast Reach Curve | action (string) data: { . request (object) } (object) required |
| media_planning/post_media_plans | Create a Media Plan | forecastMetricType (string) data: { . name (string) . sponsoredAccountUrn (string) . targetingCriteria (object) . currencyCode (string) . objectiveType (string) . optimizationType (string) . targetBudgetMicros (integer) . enableAudienceNetwork (boolean) . enableAudienceExpansion (boolean) . ctvOnly (boolean) . endDateOn (object) . startDateOn (object) } (object) required |
| media_planning/get_media_plans_urn_3ali_3amedia_plan_3a123456 | Fetch a Media Plan | accountUrn (string) |
| media_planning/get_media_plans | Fetch all Media Plans in an Ad Account | q (string) accountUrn (string) |
| pages_data_portability/get_rest_dma_organizations | dmaOrganizations FINDER parentOrganization | q (string) parent (string) |
| pages_data_portability/get_rest_dma_organizations_by_organization_id | dmaOrganizations GET | organizationId (string) required |
| pages_data_portability/get_rest_dma_organization_acls | dmaOrganizationAcls FINDER organization | start (string) count (string) q (string) organization (string) |
| pages_data_portability/get_rest_dma_organization_authorizations | dmaOrganizationAuthorizations Impersonator FINDER | bq (string) authorizationActions (string) |
| pages_data_portability/get_rest_dma_organization_authorizations_action_organization_role_authorization_action_action_type_administrator_read_organization_by_organization_id_impersonation_subject_value_member_by_person_urn_ | dmaOrganizationAuthorizations GET | organization_id (string) required personUrn (string) required |
| pages_data_portability/get_rest_dma_organization_search_appearance | dmaOrganizationSearchAppearance FINDER | q (string) organization (string) |
| pages_data_portability/get_rest_dma_organizational_page_content_analytics | dmaOrganizationalPageContentAnalytics - sourceEntity: organizationalPageUrn | q (string) metricTypes (string) sourceEntity (string) |
| pages_data_portability/get_rest_dma_organizational_page_email_domain_mapping | dmaOrganizationalPageEmailDomainMapping GET | organizationalPageUrn (string) q (string) start (string) count (string) |
| pages_data_portability/get_rest_dma_organizational_page_follows | dmaOrganizationalPageFollows FINDER followee | q (string) maxPaginationCount (string) edgeType (string) followee (string) |
| pages_data_portability/get_rest_dma_organizational_page_edge_analytics | dmaOrganizationalPageEdgeAnalytics FINDER Follower Trend | q (string) analyticsType (string) organizationalPage (string) timeIntervals (string) |
| pages_data_portability/get_rest_dma_organization_products | dmaOrganizationProducts FINDER organizationalPage | q (string) organizationalPage (string) |
| pages_data_portability/get_rest_dma_organization_products_1315691 | dmaOrganizationProducts GET | No parameters |
| pages_data_portability/get_rest_dma_pages_featured_content_groups_page_urn_3ali_3aorganizational_page_3a2414183_topic_organization_home_ | dmaPagesFeaturedContentGroups GET | No parameters |
| pages_data_portability/get_rest_dma_pages_featured_content_groups | dmaPagesFeaturedContentGroups BATCH_GET | ids (string) |
| pages_data_portability/get_rest_dma_organizational_page_profiles | dmaOrganizationalPageProfiles FINDER | q (string) pageEntity (string) locale (string) |
| pages_data_portability/get_rest_dma_organizational_page_profiles_urn_3ali_3aorganizational_page_3a10002683 | dmaOrganizationalPageProfiles GET | locale (string) |
| pages_data_portability/get_rest_dma_page_messaging_messages | Messaging Messages GET | organizationalPage (string) q (string) sort (string) thread (string) start (string) count (string) |
| pages_data_portability/get_rest_dma_page_messaging_threads | Messaging Threads GET | q (string) locale (string) organizationalPageUrn (string) sort (string) |
| pages_data_portability/get_rest_dma_employee_broadcast_analytics | Employee Broadcast Analytics GET | organizationalPageUrn (string) q (string) locale (string) timeRange (string) |
| pages_data_portability/get_rest_dma_employee_broadcast_highlights | DmaEmployeeBroadcastHighlights FINDER | q (string) organizationalPageUrn (string) |
| pages_data_portability/get_rest_dma_employee_broadcast_audience_time_series_analytics | dmaEmployeeBroadcastAudienceTimeSeriesAnalytics analyticTypes | q (string) organizationalPageEmployeeAdvocacyAnalyticsTypes (string) organizationalPageUrn (string) timeIntervals (string) |
| pages_data_portability/get_rest_dma_employee_broadcast_audience_demographic_analytics | dmaEmployeeBroadcastAudienceDemographics | q (string) audienceDimensionTypes (string) audienceType (string) organizationalPageUrn (string) timeRange (string) |
| pages_data_portability/get_rest_dma_organization_lookup | dmaOrganizationLookup BATCH_GET | ids (string) |
| pages_data_portability/get_rest_dma_organizational_page_notifications | dmaOrganizationalPageNotifications FINDER | q (string) maxPaginationCount (string) notificationTypes (string) organizationalPage (string) |
| pages_data_portability/get_rest_dma_events | dmaEvents FINDER organizer | maxPaginationCount (string) q (string) organizer (string) |
| pages_data_portability/get_rest_dma_events_7130283828383793152 | dmaEvents GET | No parameters |
| pages_data_portability/get_rest_dma_events_7132828150555701248 | dmaEvents GET - Creator setting on | No parameters |
| pages_data_portability/get_rest_dma_event_role_assignments | dmaEventRoleAssignments GET | q (string) event (string) |
| pages_data_portability/get_rest_dma_live_videos_7130261649805967360 | dmaLiveVideos GET | No parameters |
| pages_data_portability/get_rest_dma_live_videos | dmaLiveVideos BATCH_GET | ids (string) |
| pages_data_portability/get_rest_dma_live_viewer_count_analytics | dmaViewerCountAnalytics FINDER | q (string) ugcPostUrn (string) |
| pages_data_portability/get_rest_dma_lead_gen_form | This endpoint allows developers to retrieve a DMA Lead Generation Form. Request Parameters | Parameter | Type | Description | | --- | --- | --- | | owner | String | The URN of the organization | | companyID | String | The ID of the company | | q | String | The query parameter 'owner' | Response Fields In the event of a successful request, the response will contain the following fields: | Field | Type | Description | | --- | --- | --- | | paging | Object | Contains information abou | q (string) owner (string) |
| pages_data_portability/get_rest_dma_lead_gen_form_urn_3ali_3aversioned_lead_gen_form_3a_28urn_3ali_3alead_gen_form_3a7086882062019739648_2c1_29 | This endpoint allows developers to retrieve information about a specific versioned lead generation form. Request Parameters | Parameter | Type | Description | | --- | --- | --- | | id | Integer | The unique identifier of the lead generation form | Response Fields In the event of a successful request, the response will contain the following fields: | Parameter | Type | Description | | --- | --- | --- | | owner | String | The owner of the lead generation form | | hiddenFields | Arra | No parameters |
| pages_data_portability/get_rest_dma_lead_gen_form_response | dmaLeadGenFormResponse OWNER | q (string) leadType (string) owner (string) |
| pages_data_portability/get_rest_dma_lead_analytics | dmaLeadAnalytics OWNER leadType: CANDIDATE INTEREST | q (string) owner (string) pivots (string) leadTypes (string) |
| pages_data_portability/get_rest_dma_career_page_settings_urn_3ali_3aorganization_3a3811762 | dmaCareerPageSettings GET | No parameters |
| pages_data_portability/get_rest_dma_talent_brand_analytic_summaries | dmaTalentBrandAnalyticSummaries OrganizationAndTimeRange | q (string) organization (string) timeRange (string) |
| pages_data_portability/get_rest_dma_organization_commitment | dmaOrganizationCommitment FINDER organization | q (string) organization (string) |
| pages_data_portability/get_rest_dma_organization_commitment_urn_3ali_3aorganization_commitment_3a_28urn_3ali_3aorganization_3a3811762_2c5_29 | dmaOrganizationCommitment GET | No parameters |
| pages_data_portability/get_rest_dma_organization_workplace_policies_urn_3ali_3aorganization_workplace_policy_3a_28urn_3ali_3aorganization_3a3811762_2c1071884713627764290_29 | dmaOrganizationWorkplacePolicies GET | No parameters |
| pages_data_portability/get_rest_dma_organization_workplace_policies | dmaOrganizationWorkplacePolicies FINDER | organization (string) q (string) |
| pages_data_portability/get_rest_dma_organization_life_page_traffic_statistics | dmaOrganizationLifePageTrafficStatistics FINDER organization | q (string) organization (string) reportingIds (string) timeRange (string) |
| pages_data_portability/get_rest_dma_organization_targeted_contents_urn_3ali_3aorganization_targeted_content_3a_28urn_3ali_3aorganization_3a3811762_2c752c3d33_0787_45de_b71f_908800ef8aef_29 | dmaOrganizationTargetedContents GET | No parameters |
| pages_data_portability/get_rest_dma_organization_targeted_contents | dmaOrganizationTargetedContents BATCH_GET | ids (string) |
| pages_data_portability/get_dma_organization_relationship_statistics | dmaOrganizationRelationshipStatistics FINDER | organization (string) q (string) sortType (string) timeWindow (string) |
| pages_data_portability/get_dma_organization_photos | dmaOrganizationPhotos BATCH_GET | ids (string) |
| pages_data_portability/get_dma_organization_photos_urn_3ali_3aorganization_photo_3a_28urn_3ali_3aorganization_3a3811762_2cce5962bd_7c04_44df_a6e6_91ed21a91771_29 | dmaOrganizationPhotos GET | No parameters |
| pages_data_portability/get_dma_posts | dmaPosts BATCH_GET 200 1 opt-in org post share - AUTHOR | ids (string) viewContext (string) |
| pages_data_portability/get_rest_dma_reactions | dmaReactions BATCH_GET 200 1 opt-in reactionUrn personUrn on Page activity | ids (string) |
| pages_data_portability/get_dma_comments | dmaComments BATCH_GET 200 1 opt-in user comment on Page share | ids (string) |
| pages_data_portability/get_rest_dma_ingested_content_summaries | dmaIngestedContentSummaries BATCH_GET 200 2 opt-out / 1 opt-in articleUrns | ids (string) |
| pages_data_portability/get_dma_instant_reposts | dmaInstantReposts BATCH_GET 200 1 opt-in page share | ids (string) |
| pages_data_portability/get_dma_social_metadata | dmaSocialMetadata BATCH_GET 200 Page share | ids (string) |
| pages_data_portability/get_dma_content_public_url | dmaContentPublicUrl BATCH_GET Copy | ids (string) |
| pages_data_portability/get_dma_activities | dmaActivities BATCH_GET 200 1 opt-in share | ids (string) |
| pages_data_portability/get_rest_dma_activities | dmaActivities BATCH_GET 200 1 opt-in share | ids (string) |
| pages_data_portability/get_rest_dma_product_categories | dmaProductCategories BATCH_GET | ids (string) locale (string) |
| pages_data_portability/get_rest_dma_product_categories_10030 | dmaProductCategories GET | locale (string) |
| pages_data_portability/get_rest_dma_featured_commitment_taxonomy_versions_default_dma_featured_commitment | dmaFeaturedCommitmentTaxonomyVersions BATCH_GET | ids (string) locale (string) |
| pages_data_portability/get_rest_dma_featured_commitment_taxonomy_versions_default_dma_featured_commitment_2 | dmaFeaturedCommitmentTaxonomyVersions GET | locale (string) |
| pages_data_portability/get_rest_dma_benefit_taxonomy_versions_default_dma_benefits | dmaBenefitTaxonomyVersions BATCH_GET | ids (string) locale (string) |
| pages_data_portability/get_rest_dma_benefit_taxonomy_versions_default_dma_benefits_6 | dmaBenefitTaxonomyVersions GET | locale (string) |
| pages_data_portability/get_rest_dma_degrees | dmaDegrees GET_ALL | start (string) count (string) locale (string) |
| pages_data_portability/get_rest_dma_degrees_123 | dmaDegrees GET | locale (string) |
| pages_data_portability/get_rest_dma_fields_of_study | dmaFieldsOfStudy GET_ALL | locale (string) start (string) count (string) |
| pages_data_portability/get_rest_dma_fields_of_study_100001 | dmaFieldsOfStudy GET | locale (string) |
| pages_data_portability/get_rest_dma_functions | dmaFunctions GET_ALL | start (string) count (string) locale (string) |
| pages_data_portability/get_rest_dma_functions_2 | dmaFunctions GET | locale (string) |
| pages_data_portability/get_rest_dma_geo_103644278 | dmaGeo GET | locale (string) |
| pages_data_portability/get_rest_dma_geo | dmaGeo BATCH_GET | ids (string) locale (string) |
| pages_data_portability/get_rest_dma_skills | dmaSkills GET_ALL | start (string) count (string) locale (string) |
| pages_data_portability/get_rest_dma_skills_5 | dmaSkills GET | locale (string) |
| pages_data_portability/get_rest_dma_standardized_industries | dmaStandardizedIndustries GET_ALL | start (string) count (string) locale (string) |
| pages_data_portability/get_rest_dma_standardized_industries_1 | dmaStandardizedIndustries GET | No parameters |
| pages_data_portability/get_rest_dma_standardized_seniorities_10 | dmaStandardizedSeniorities GET | No parameters |
| pages_data_portability/get_rest_dma_standardized_seniorities | dmaStandardizedSeniorities GET_ALL | start (string) count (string) locale (string) |
| pages_data_portability/get_rest_dma_titles_5 | dmaTitles GET | No parameters |
| pages_data_portability/get_rest_dma_titles | dmaTitles GET_ALL | start (string) count (string) locale (string) |
| pages_data_portability/get_rest_dma_super_titles_407 | dmaSuperTitles GET | locale (string) |
| pages_data_portability/get_rest_dma_super_titles | dmaSuperTitles GET_ALL | locale (string) |
| pages_data_portability/get_rest_dma_creator_analytics | dmaCreatorAnalytics FINDER Video Play Total Count | q (string) targetEntity (string) metric (string) queryType (string) |
| pages_data_portability/get_rest_dma_original_articles_by_article_li_urn | dmaOriginalArticles GET | articleLiUrn (string) required context (string) |
| pages_data_portability/get_rest_dma_original_articles | dmaOriginalArticles BATCH_GET | ids (string) |
| pages_data_portability/get_rest_dma_content_series_by_newsletter_urn | dmaContentSeries GET | newsletterUrn (string) required |
| pages_data_portability/get_rest_dma_content_series | dmaContentSeries BATCH_GET | ids (string) |
| pages_data_portability/get_rest_dma_series_subscribers | dmaSeriesSubscribers FINDER | q (string) contentSeries (string) maxPaginationCount (string) |
| pages_data_portability/get_rest_dma_people_id_syab_jjcce_p_ | dmaPeople GET | No parameters |
| pages_data_portability/get_rest_dma_me | dmaMe GET | fields (string) |
| pages_data_portability/get_rest_dma_business_manager_accounts_21002 | dmaBusinessManagerAccounts GET | No parameters |
| pages_data_portability/get_rest_dma_business_manager_accounts | dmaBusinessManagerAccounts BATCH _GET | ids (string) |
| pages_data_portability/get_rest_dma_business_manager_account_organizations | dmaBusinessManagerAccountOrganizations FINDER | bq (string) organizations (string) start (string) count (string) |
| pages_data_portability/get_dma_verification_agents | dmaVerificationAgents organizationalPage | organizationalPage (string) q (string) |
| parent_application_management/post_v2_provisioned_applications | Use this API Endpoint when partner wants to create a child application for any of mutual customer. Refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/provisioning-api create-application for more information. | data (object) required |
| parent_application_management/post_v2_provisioned_applications_by_customer_application_urn | Use this API Endpoint when partner wants to update JavaScript SDK domain for child application for any of mutual customer. Refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/provisioning-api update-application for more information. | customer_application_urn (string) required data (object) required |
| parent_application_management/get_v2_provisioned_applications | Use this API Endpoint when partner wants to fetch a child application for any of our mutual customer. Refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/provisioning-api get-application for more information. | q (string) uniqueForeignId (string) |
| recruiter_system_connect/post_oauth_v2_access_token | Updating Customer Integration by using Child Application token | No parameters |
| recruiter_system_connect/post_v2_ats_integrations | /atsIntegrations used to update the customer Integration. To enable ONE_CLICK_EXPORT, use integrationType=ONE_CLICK_EXPORT in the request body. Partner can update other RSC Integrations by changing integrationType.ONE_CLICK_EXPORT is Company level Integration. To know more , please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-customer-configuration sample-request | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) ids1.integrationContext (string) ids1.integrationType (string) ids1.tenantType (string) ids1.dataProvider (string) ids2.integrationContext (string) ids2.integrationType (string) ids2.tenantType (string) ids2.dataProvider (string) ids3.integrationContext (string) ids3.integrationType (string) ids3.tenantType (string) ids3.dataProvider (string) data: { . entities (object) } (object) required |
| recruiter_system_connect/get_v2_ats_integrations | Verify Customer's ATSIntegrations | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) ids1.integrationContext (string) ids1.integrationType (string) ids1.tenantType (string) ids1.dataProvider (string) ids2.integrationContext (string) ids2.integrationType (string) ids2.tenantType (string) ids2.dataProvider (string) ids3.integrationContext (string) ids3.integrationType (string) ids3.tenantType (string) ids3.dataProvider (string) |
| recruiter_system_connect/put_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_one_click_export_tenant_type_recruiter_data_provider_ats_configurations | Once a customer creates an integration requiring configuration, you must create the configuration using this API before they can enable the integration.Callback URL is mandatory for enabling Integration.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types upsert-integration-configurations | org_id (string) required ids (string) data (object) required |
| recruiter_system_connect/put_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_in_ats_indicator_tenant_type_recruiter_data_provider_ats_configurations | API governs who may view job-related data Interview Feedback, Notes, Applications, and Stages within the In-ATS indicator.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types integration-configuration-keys | org_id (string) required ids (string) data: { . entities (object) } (object) required |
| recruiter_system_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_one_click_export_tenant_type_recruiter_data_provider_ats_configurations | Customer can delete JOB_POSTING_VIEWERS Integration using this API. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types delete-integration-configurations | org_id (string) required ids (string) |
| recruiter_system_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_in_ats_indicator_tenant_type_recruiter_data_provider_ats_configurations | Customer can delete APPLICATION_VIEWERS Integration using this API. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types delete-integration-configurations | org_id (string) required ids (string) |
| recruiter_system_connect/get_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_one_click_export_tenant_type_recruiter_data_provider_ats_configurations | API used to retrieve the Customer Integration Configurations.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types verify-integration-configurations | org_id (string) required ids (string) |
| recruiter_system_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_one_click_export_tenant_type_recruiter_data_provider_ats | Delete ATS Integration ONE_CLICK_EXPORT | org_id (string) required |
| recruiter_system_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_in_ats_indicator_tenant_type_recruiter_data_provider_ats | Delete ATS Integration IN_ATS_INDICATOR | org_id (string) required |
| recruiter_system_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_profile_plugin_tenant_type_recruiter_data_provider_ats | Delete ATS Integration PROFILE_PLUGIN | org_id (string) required |
| recruiter_system_connect/delete_v2_ats_integrations_integration_context_urn_li_contract_by_contract_id_integration_type_csa_api_tenant_type_recruiter_data_provider_ats | Delete ATS Integration CSA_API | contract_id (string) required |
| recruiter_system_connect/post_v2_simple_job_postings | This call is for Syncing PUBLIC Jobs to LinkedIn from ATS. availability field set to PUBLIC. Please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/job-postings/api/job-posting-api-schema recruiter-system-connect-extension-schema | data (object) required |
| recruiter_system_connect/get_v2_simple_job_posting_tasks | /SimpleJobPostingTasks used to track the Status of Jobs. To learn more please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/job-postings/api/check-job-taskstatus To test and view the Jobs that you successfully posted , use https://www.linkedin.com/jobs/view/ jobPosting ID jobPosting ID can be get from the response of /SimpleJobpostingtask eg:https://www.linkedin.com/jobs/view/2635675045 | ids (string) |
| recruiter_system_connect/put_v2_ats_candidates | Customers can use /atsCandidates to sync candidates. Use your candidate identifier while syncing candidates via API. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-candidates sync-candidates-1 | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) data (object) required |
| recruiter_system_connect/get_v2_ats_candidates | Once customer Sync the candidates, customers can retrieve candidate details, which will include any algorithmic and user-supplied matches with LinkedIn members. Candidate Match can be two types: 1.matchedMembers 2.manualMatchedMember To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-candidates retrieve-candidate-matches | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| recruiter_system_connect/post_v2_ats_candidates | API used to attach a Person URN to a candidate.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-candidates attach-person-urn-to-candidate | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) data: { . entities (object) } (object) required |
| recruiter_system_connect/put_v2_ats_candidates_ats_candidate_id_by_candidate_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_notes | Customer can use /atsCandidates endpoint to create and update candidate notes.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-candidate-notes | candidate_id (string) required org_id (string) required ids (string) data (object) required |
| recruiter_system_connect/put_v2_ats_applications | /atsApplications to Sync Job Applications.Use Customer job application identifier when syncing via the API.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-applications | ids0.atsJobApplicationId (string) ids0.dataProvider (string) ids0.integrationContext (string) data (object) required |
| recruiter_system_connect/post_v2_hire_media_url | /hireMediaUrl to create signed URL from LinkedIn and then use for uploading the file. please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-applications resume-upload | data: { . usageParameters (object) . contentType (string) . fileName (string) . blobTtl (object) . hiringContext (string) } (object) required |
| recruiter_system_connect/put_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_resumes | /atsApplications to Sync Job Applications.Use Customer job application identifier when syncing via the API.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-applications | application_id (string) required org_id (string) required ids (string) data (object) required |
| recruiter_system_connect/put_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_notes | /atsApplications to create or update Application Notes.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-application-notes | application_id (string) required org_id (string) required ids (string) data (object) required |
| recruiter_system_connect/put_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_interview_feedback | Endpoint to create and update application interview feedbacK. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-application-interview-feedback | application_id (string) required org_id (string) required ids (string) data (object) required |
| recruiter_system_connect/put_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_stages | Sync Application Stages | application_id (string) required org_id (string) required ids (string) data (object) required |
| recruiter_system_connect/get_v2_exported_candidates | When the callback URL has received a notification event of EXPORT_CANDIDATE_PROFILE type after One_Click_Export, you should then make an API call to retrieve the limited profile information of the exported candidate.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/retrieve-exported-candidates retrieving-exported-candidate-information | q (string) requestId (string) |
| recruiter_system_connect/get_v2_seats_v2 | /seats used to retrieve the details of Contract Seat holders including name, email Id and unique ID.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/recruiter-prospect-interactions/recruiter-seatholders seats-deprecation-set-for-april-1-2022 | q (string) active (string) count (string) start (string) contracts (string) |
| recruiter_system_connect/get_v2_conversation_events | InMail History API allows you to retrieve InMail activity, both sent and received, that occurred on a given LinkedIn Recruiter contract.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/recruiter-prospect-interactions/inmail-history api-endpoint | q (string) viewer (string) timeRange.end (string) timeRange.start (string) start (string) count (string) |
| recruiter_system_connect/get_v2_mail_stubs | InMail Stub Profile API allows you to retrieve basic profile data of LinkedIn members that have replied to InMails sent from Recruiter seat holders.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/recruiter-prospect-interactions/inmail-stub-profiles | q (string) start (string) count (string) contract (string) createdDateStart (string) createdDateEnd (string) owners (string) |
| recruiter_system_connect/get_v2_prospect_notes | Prospect Notes API allows you to retrieve notes that were created about prospects on a given Recruiter contract.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/recruiter-prospect-interactions/prospect-notes | q (string) start (string) contract (string) cutoffDate (string) beforeDate (string) count (string) owners (string) |
| recruiter_system_connect/get_v2_me | GET Person ID - With 3 legged OAuth Flow - r_liteprofile permission | fields (string) |
| recruiter_system_connect/put_v2_ats_entity_acls | Visibility of your customer's synced entities within LinkedIn products will depend on the ACLs you sync using /atsEntityAcls.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-acls sync-entity-acls | ids0.atsEntityAclId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.atsEntityType (string) ids0.atsEntityId (string) data: { . entities (object) } (object) required |
| recruiter_system_connect/get_v2_ats_entity_acls | API used to retrieve the details of already Sync ACL.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-acls retrieve-entity-acls | atsEntityId (string) atsEntityType (string) dataProvider (string) integrationContext (string) q (string) start (string) count (string) |
| recruiter_system_connect/delete_v2_ats_entity_acls | Endpoint used to delete already Synced ACL.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-acls delete-entity-acls | ids0.atsEntityAclId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.atsEntityId (string) ids0.atsEntityType (string) |
| recruiter_system_connect/put_v2_ats_entity_acl_assignees | Endpoint to create and update ACL entities for assignees. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-acls upsert-entity-acl-assignees | ids0.atsEntityAclId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.assignee (string) ids0.atsEntityType (string) data: { . entities (object) } (object) required |
| recruiter_system_connect/get_v2_ats_entity_acl_assignees | Endpoint to retrieve details of already synced ACL Assignees. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-acls retrieve-entity-acl-assignee | q (string) assignee (string) dataProvider (string) integrationContext (string) |
| recruiter_system_connect/delete_v2_ats_entity_acl_assignees | Endpoint to delete already synced ACL Assignees. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/sync-acls delete-entity-acl-assignees | ids0.atsEntityAclId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.assignee (string) ids0.atsEntityType (string) |
| recruiter_system_connect/delete_v2_ats_candidates | Delete on the /atsCandidates endpoint to deletes records. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-data-deletion delete-candidates | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| recruiter_system_connect/delete_v2_ats_candidates_ats_candidate_id_by_candidate_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_notes | DELETE on /atsCandidates/CandidateIdentifier/notes endpoint to delete candidate notes.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-data-deletion delete-candidate-notes | candidate_id (string) required org_id (string) required ids (string) |
| recruiter_system_connect/delete_v2_ats_applications | DELETE on /atsApplications endpoint to delete Application records. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-data-deletion delete-applications | ids0.atsJobApplicationId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| recruiter_system_connect/delete_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_notes | DELETE on the endpoint /atsApplications/JobApplicationIdentifier/notes to delete application notes. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-data-deletion delete-application-notes | application_id (string) required org_id (string) required ids (string) |
| recruiter_system_connect/delete_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_interview_feedback | DELETE on the endpoint /atsApplications/JobApplicationIdentifier/interviewFeedback to delete interviews.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-data-deletion delete-application-interview-feedback | application_id (string) required org_id (string) required ids (string) |
| recruiter_system_connect/delete_v2_ats_applications_ats_job_application_id_by_application_id_data_provider_ats_integration_context_urn_li_organization_by_org_id_stages | DELETE on the endpoint /atsApplications/JobApplicationIdentifier/stages to delete Job Application Stages.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-data-deletion delete-application-stages | application_id (string) required org_id (string) required ids (string) |
| reporting_roi/get_ad_analytics | This API slice the conversion and the campaign data against campaign name, type, status and campaign group projection. | q (string) dateRange (string) timeGranularity (string) accounts (string) pivots (string) fields (string) |
| talent_crm_connect/post_oauth_v2_access_token | Updating Customer Integration by using Child Application token | No parameters |
| talent_crm_connect/post_v2_ats_integrations | /atsIntegrations used to update the customer Integration. To enable ONE_CLICK_EXPORT, use integrationType=ONE_CLICK_EXPORT in the request body. Partner can update other RSC Integrations by changing integrationType.ONE_CLICK_EXPORT is Company level Integration. To know more , please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/recruiter-system-connect/rsc-customer-configuration sample-request | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) ids1.integrationContext (string) ids1.integrationType (string) ids1.tenantType (string) ids1.dataProvider (string) ids2.integrationContext (string) ids2.integrationType (string) ids2.tenantType (string) ids2.dataProvider (string) ids3.integrationContext (string) ids3.integrationType (string) ids3.tenantType (string) ids3.dataProvider (string) data: { . entities (object) } (object) required |
| talent_crm_connect/get_v2_ats_integrations | Verify Customer's ATSIntegrations | ids0.integrationContext (string) ids0.integrationType (string) ids0.tenantType (string) ids0.dataProvider (string) ids1.integrationContext (string) ids1.integrationType (string) ids1.tenantType (string) ids1.dataProvider (string) ids2.integrationContext (string) ids2.integrationType (string) ids2.tenantType (string) ids2.dataProvider (string) ids3.integrationContext (string) ids3.integrationType (string) ids3.tenantType (string) ids3.dataProvider (string) |
| talent_crm_connect/put_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_crm_one_click_export_tenant_type_recruiter_data_provider_ats_configurations | Once a customer creates an integration requiring configuration, you must create the configuration using this API before they can enable the integration.Callback URL is mandatory for enabling Integration.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types upsert-integration-configurations | org_id (string) required ids (string) data (object) required |
| talent_crm_connect/put_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_in_crm_indicator_tenant_type_recruiter_data_provider_ats_configurations | API governs who may view job-related data Interview Feedback, Notes, Applications, and Stages within the In-ATS indicator.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types integration-configuration-keys | org_id (string) required ids (string) data: { . entities (object) } (object) required |
| talent_crm_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_one_click_export_tenant_type_recruiter_data_provider_ats_configurations | Customer can delete JOB_POSTING_VIEWERS Integration using this API. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types delete-integration-configurations | org_id (string) required ids (string) |
| talent_crm_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_in_ats_indicator_tenant_type_recruiter_data_provider_ats_configurations | Customer can delete APPLICATION_VIEWERS Integration using this API. To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types delete-integration-configurations | org_id (string) required ids (string) |
| talent_crm_connect/get_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_crm_one_click_export_tenant_type_recruiter_data_provider_ats_configurations | API used to retrieve the Customer Integration Configurations.To know more, please refer herehttps://docs.microsoft.com/en-us/linkedin/talent/middleware-platform/integration-types verify-integration-configurations | org_id (string) required ids (string) |
| talent_crm_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_one_click_export_tenant_type_recruiter_data_provider_ats | Delete ATS Integration ONE_CLICK_EXPORT | org_id (string) required |
| talent_crm_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_in_ats_indicator_tenant_type_recruiter_data_provider_ats | Delete ATS Integration IN_ATS_INDICATOR | org_id (string) required |
| talent_crm_connect/delete_v2_ats_integrations_integration_context_urn_li_organization_by_org_id_integration_type_profile_plugin_tenant_type_recruiter_data_provider_ats | Delete ATS Integration PROFILE_PLUGIN | org_id (string) required |
| talent_crm_connect/delete_v2_ats_integrations_integration_context_urn_li_contract_by_contract_id_integration_type_cas_profile_tenant_type_recruiter_data_provider_ats | Delete ATS Integration CSA_PROFILE | contract_id (string) required |
| talent_crm_connect/put_v2_ats_candidates | Sync TCRM Candidates | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) data (object) required |
| talent_crm_connect/get_v2_ats_candidates | Get TCRM Candidates | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| talent_crm_connect/delete_v2_ats_candidates | Delete TCRM Candidates | ids0.atsCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| talent_crm_connect/put_v2_tcrm_pipelines | Sync TCRM Pipelines | ids0.tcrmPipelineId (string) ids0.dataProvider (string) ids0.integrationContext (string) data (object) required |
| talent_crm_connect/delete_v2_tcrm_pipelines | Delete TCRM Pipelines | ids0.tcrmPipelineId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| talent_crm_connect/put_v2_tcrm_pipeline_stages | Sync TCRM PipelineStages | ids0.tcrmPipelineId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.tcrmStageId (string) data (object) required |
| talent_crm_connect/delete_v2_tcrm_pipeline_stages | Delete TCRM PipelineStages | ids0.tcrmPipelineId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.tcrmStageId (string) |
| talent_crm_connect/put_v2_tcrm_candidate_pipelines | Sync TCRM CandidatePipelines | ids0.tcrmCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.tcrmPipelineId (string) data (object) required |
| talent_crm_connect/delete_v2_tcrm_candidate_pipelines | Delete TCRM CandidatePipelines | ids0.tcrmCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.tcrmPipelineId (string) |
| talent_crm_connect/put_v2_tcrm_candidate_pipeline_stages | Sync TCRM CandidatePipelineStages | ids0.tcrmCandidatePipelineStageId (string) ids0.dataProvider (string) ids0.integrationContext (string) data (object) required |
| talent_crm_connect/delete_v2_tcrm_candidate_pipeline_stages | Sync TCRM CandidatePipelineStages Copy | ids0.tcrmCandidatePipelineStageId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| talent_crm_connect/put_v2_tcrm_candidate_resumes | Sync TCRM CandidateResumes | ids0.tcrmCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.tcrmResumeId (string) data (object) required |
| talent_crm_connect/delete_v2_tcrm_candidate_resumes | Delete TCRM CandidateResumes | ids0.tcrmCandidateId (string) ids0.dataProvider (string) ids0.integrationContext (string) ids0.tcrmResumeId (string) |
| talent_crm_connect/put_v2_tcrm_interactions | Sync TCRM Interactions | ids0.tcrmInteractionId (string) ids0.dataProvider (string) ids0.integrationContext (string) data (object) required |
| talent_crm_connect/delete_v2_tcrm_interactions | Delete TCRM Interactions | ids0.tcrmInteractionId (string) ids0.dataProvider (string) ids0.integrationContext (string) |
| talent_crm_connect/get_v2_exported_candidates | GET Notification Type EXPORT_CANDIDATE_PROFILE | q (string) requestId (string) |
| talent_crm_connect/get_v2_conversation_events | Retrieve InMail History | q (string) viewer (string) timeRange.end (string) timeRange.start (string) start (string) count (string) |
| talent_crm_connect/get_v2_seats_v2 | Retrieve Recruiter Seatholders | q (string) contracts (string) count (string) start (string) |
| talent_crm_connect/get_v2_mail_stubs | Retrieve InMail Stub Profiles | q (string) start (string) count (string) contract (string) createdDateStart (string) createdDateEnd (string) owners (string) |
| verified_on_linkedin/get_rest_identity_me | The Identity API /identityMe provides a simple way for partners to retrieve LinkedIn Member profile details. Learn more https://learn.microsoft.com/en-us/linkedin/consumer/integrations/verified-on-linkedin/api-reference/identity-me?context=linkedin%2Fconsumer%2Fcontext by viewing our public documentation. | No parameters |
| verified_on_linkedin/get_rest_verification_report | The Verification Report API allows partners to retrieve the verified categories for example, IDENTITY, WORKPLACE associated with a LinkedIn Member, or to obtain a verificationUrl that enables Members to complete eligible verifications on LinkedIn. Learn more https://learn.microsoft.com/en-us/linkedin/consumer/integrations/verified-on-linkedin/api-reference/verification-report?context=linkedin%2Fconsumer%2Fcontext by viewing our public documentation. | No parameters |
| verified_on_linkedin/post_rest_validation_status | The Validation Status API lets Plus-tier partners check the current validation state of LinkedIn members at scale single or bulk. It returns compact status flags for identity, workplace, and profileInformationStatus.Learn more https://learn.microsoft.com/en-us/linkedin/consumer/integrations/verified-on-linkedin/api-reference/validation-status?context=linkedin%2Fconsumer%2Fcontext by viewing our public documentation. | action (string) data: { . validationQueries (array) } (object) required |