Partager via

Archived Marketing API Changes 2020

  • Article

Warning

Deprecation Notice
The Marketing Version 202311 (Marketing November 2023) and earlier versions (excluding 202306 and 202307) have been sunset. Additionally, the unversioned APIs will be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management APIs to avoid disruptions. See the Migration page for more details. If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.

December 2020

Campaign Management

  • Updates to Message & Conversation Ads
    • Who’s impacted: Partners using the Message & Conversation Ads API
    • What’s happening: Starting July 5, 2021, we are changing how you create a Message or Conversation ad:
      • You can update creatives that are not in the DRAFT status for Message/Conversation Ads.
      • The AdInMailContent’s editable field will not be automatically set to false any longer.
      • The Sponsored Conversation’s editable field will be set to false when an AdInMailContent is associated with a SponsoredConversation. When calling the adInMailContentsV2 endpoint with a subContent of type AdInMailGuidedRepliesSubContent, the editable field of the referenced SponsoredConversation will be set to false automatically.
  • Support for additional currencies
    • Who’s impacted: Partners using the adAccountsV2 API
    • What’s happening: Starting February 24, 2021, the account creation endpoint adAccountsV2 will support creating ad accounts with 14 new currencies. Learn more.

Reporting & ROI

  • We discovered two measurement issues
    • Who’s impacted: All reporting partners
    • What’s happening: We are committed to transparency and the integrity of our ads products, and we wanted to let you know about two measurement issues that our engineering team discovered in August and subsequently fixed on November 10. As a result of these issues, we may have over-reported some of your customers’ Sponsored Content campaign performance metrics. You can learn more by reading our blog post.

Audiences

  • New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: Starting March 31, 2021, we will be introducing granular rate limits for our DMP streaming APIs (Users & Companies) to prevent abuse, ensure service stability, and consistent API availability. These limits will be enforced in addition to your current daily limits, which can be found through Developer Portal > My Apps > App > Analytics > Quotas and usage.
      • What does this mean for my application? If your application calls /dmpSegments/users or /dmpSegments/companies, you may get a HTTP 429 response if calling the endpoints too frequently, indicating that you are exceeding the rate limits.
      • How do I handle API calls that are throttled? Your application should be catching errors when making calls to /dmpSegment/users and /dmpSegment/companies and retry after a minimum of 1 second whenever you receive an HTTP 429 response.
      • Can I get the limits increased for my application? No, the limits we intend to enforce will not be customizable at an application level. However the limits will be enforced such that there is minimal interruption to existing applications.
      • My application creates a significant amount of automated API calls (eg. one time full data dump or weekly data pushes with large volumes followed by smaller traffic that contains diffs throughout the week). Will this rate limit affect my throughput ? If the volume of your automated traffic exceeds tens of millions, then you can expect to see frequent throttling. While this might affect the throughput of your API calls, you will not see any differences in the matched audience processing SLA.

Breaking Changes

  • New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting March 31, 2021, we will reject calls that do not meet the new requirements.
  • UGC permalinkSuffixes endpoint removed
    • Who's impacted: Partners using the UGC permalinkSuffixes finder endpoint
    • What's happening: The permalinkSuffixes endpoint has been removed. To retrieve UGC posts, we recommend you find posts by author.

October 2020

  • Page Management
    • New validations for mentions
      • Who’s impacted: Partners using the Shares and UGC Posts APIs
      • What’s happening: New validations for the start and length fields for mentions that require the following: length must be greater than 0, start must be greater than or equal to 0, and start + length must be less than the length of the text. If these requirements are not met, the request will result in a 400 error code.
    • UGC Posts duplicate content error code change
      • Who's impacted: Partners using the UGC Posts API
      • What's happening: Previously, requests to create duplicate UGC Posts returned a 409 error code. Now, these requests return a 422 error code.
  • Reporting & ROI
    • Increased pivot values on Statistics Finder
      • Who's impacted: Partners using the Ad Analytics Statistics Finder
      • What's happening: The Statistics Finder now supports grouping results by up to 3 pivot values. See Ad Analytics to learn more.
  • Breaking Changes
    • [Optional to Required] campaignGroup field for campaign creation
      • Who’s impacted: Partners using adCampaignsV2
      • What’s happening: Starting October 30, 2020, campaignGroup field in adCampaignsV2 endpoint will change from optional to required. Any calls to the adCampaignsV2 endpoint to create a new campaign that do not specify campaignGroup will fail and return a 400.
    • Integrate Lifetime Pacing for a better customer experience
      • Who’s impacted: Partners using adCampaignsV2
      • What’s happening: We recommend you integrate Lifetime Pacing by September 30 not only for improved ROI but also for a better customer experience. Starting in end-September, all campaigns created in LinkedIn Campaign Manager will be lifetime pacing campaigns only. The biggest impact will be on customers who create campaigns in LinkedIn Campaign Manager and then manage budgets via your platform. If you choose not to integrate Lifetime Pacing, you will still need to update API restrictions. For example, setting total budget + daily budget with fixed schedule or total budget run continuously are no longer valid options.
    • [Warning] Deprecation of totalBudget and totalBudgetEndsAt
      • Who’s impacted: all partners using adAccountsV2
      • What’s happening: Starting October 30, 2020, totalBudget and totalBudgetEndAt field in adAccountsV2 will be deprecated. All budget and run date information should be set and read at the Campaign Group level. totalBudget from adAccountsV2 maps to totalBudget in adCampaignGroupsV2 and totalBudgetEndAt maps to runSchedule.end in adCampaignGroupsV2.

September 2020

General API

  • Specify synchronous upload when creating a post with an image
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: When creating a post with an image, you are required to specify “SYNCHRONOUS_UPLOAD” as supportedUploadMechanism in registerUploadRequest Json to make sure an image asset is created. Learn more.

Optimization

  • Integrate Lifetime Pacing for a better customer experience
    • Who’s impacted: Partners using the adCampaigns API
    • What’s happening: We recommend you integrate Lifetime Pacing by September 30 not only for improved ROI but also for a better customer experience. Starting in end-September, all campaigns created in LinkedIn Campaign Manager will be lifetime pacing campaigns only. The biggest impact will be on customers who create campaigns in LinkedIn Campaign Manager and then manage budgets via your platform. If you choose not to integrate Lifetime Pacing, you will still need to update API restrictions. For example, setting total budget + daily budget with fixed schedule or total budget run continuously are no longer valid options.

Migrations

  • [Warning] Deprecation of totalBudget and totalBudgetEndsAt
    • Who’s impacted: all partners using adAccountsV2
    • What’s happening: Starting October 30, 2020, totalBudget and totalBudgetEndAt field in adAccountsV2 will be deprecated. All budget and run date information should be set and read at the Campaign Group level. totalBudget from adAccountsV2 maps to totalBudget in adCampaignGroupsV2 and totalBudgetEndAt maps to runSchedule.end in adCampaignGroupsV2.
  • [Optional to Required] campaignGroup field
    • Who's impacted: all partners using adCampaignsV2
    • What's happening: campaignGroup field in adCampaignsV2 endpoint will be a required field (currently is optional). Any campaign creation calls to the adCampaignsV2 endpoint that do not specify campaignGroup will fail and return a 400 starting October 30, 2020.
  • [Reminder] Enforced projections for adAnalyticsV2
    • Who’s impacted: Partners using the adAnalytics API.
    • What’s happening: The /adAnalyticsV2 API will require all callers to request only the metrics they need from the API by using the fields parameter. There will also be an enforcement of 20 fields maximum per request.
    • When: September 30, 2020. After this date, any request without fields= will return a 400. Additionally any request asking for more than 20 fields will return a 400.

August 2020

General API

  • OAuth refresh tokens now available for all partners
    • Who’s impacted: All partners
    • What’s happening: Refresh tokens create a more seamless authorization experience for your customers. Customers will only be required to explicitly authorize your application once each year. While access tokens are still only valid for 60 days, you can now programmatically get new access tokens using refresh tokens for up to a year. Note, there may however be cases where LinkedIn expires tokens sooner. Please refer to the documentation to get started.
  • UGC video posts now available
    • Who’s impacted: All partners
    • What’s happening: Previously restricted to a limited audience, the ability to create a video post using the UGC Post API is now generally available.
  • Sort UGC posts by last modified or created date
    • Who’s impacted: Partners using the UGC Post author finder API and Shares owner finder API
    • What’s happening: UGC author finder and Shares owner finder now support retrieving ugcPosts chronologically by setting the optional parameter ‘sortBy’ to ‘CREATED’. The default sort option is ‘LAST_MODIFIED’, which means Shares and UGC posts are ordered by last modified time instead of creation time (most recent to least recent).
  • Enable and disable comments on threads through the socialMetadata API
    • Who’s impacted: All partners
    • What’s happening: You can now enable or disable comments on threads. Disabling comments will delete all existing comments and prevent new ones from being written on the thread. Enabling comments will allow new comments to be written.
  • Campaign Groups campaign creation limit increase
    • Who's impacted: Partners using the adCampaignsGroups API.
    • What’s happening: We have increased the limit from 1,000 to 2,000 campaigns per non-default campaign group. Learn more here.
  • Enable and disable comments on threads through the socialMetadata API
    • Who's impacted: All partners
    • What's happening: You can now enable or disable comments on threads. Disabling comments will delete all existing comments and prevent new ones from being written on the thread. Enabling comments will allow new comments to be written.

Optimization

  • Integrate Lifetime Pacing to avoid breaking the campaign management experience for your customers
    • Who's impacted: Partners using the adCampaigns API
    • What's happening: We recommend you integrate Lifetime Pacing by Sept 30 to avoid breaking the campaign management experience for your customers. The experience may break for customers that create a Lifetime Pacing campaign in LinkedIn's UI and edits in a partner platform. Use the parameter "pacingStrategy=LIFETIME" when you save the campaigns using adCampaigns API.

Migrations

  • [Warning] Deprecation of totalBudget and totalBudgetEndsAt
    • Who's impacted: all partners using adAccountsV2
    • What's happening: totalBudget and totalBudgetEndAt field in adAccountsV2 will be deprecated starting October 30, 2020. All budget and run date information should be set and read at the Campaign Group level. totalBudget from adAccountsV2 maps to totalBudget in adCampaignGroupsV2 and totalBudgetEndAt maps to runSchedule.end in adCampaignGroupsV2.
  • [Optional to Required] campaignGroup field
    • Who's impacted: all partners using adCampaignsV2
    • What's happening: campaignGroup field in adCampaignsV2 endpoint will be a required field (currently is optional). Any campaign creation calls to the adCampaignsV2 endpoint that do not specify campaignGroup will fail and return a 400 starting October 30, 2020.
  • [Extension] Enforced projections for adAnalyticsV2
    • Who's impacted: Partners using the adAnalytics API.
    • What's happening: The /adAnalyticsV2 API will require all callers to request only the metrics they need from the API by using the fields= parameter. There will also be an enforcement of 20 fields maximum per request.
    • When: We have extended the deadline by 60 days to September 30, 2020. After this date, any request without fields= will return a 400. Additionally any request asking for more than 20 fields will return a 400.

July 2020

General API

  • Introducing LinkedIn's New OAuth Token Inspector Tool & API

    • Who's impacted: All partners
    • What's happening: The new token inspector tool which allows you to check detailed metadata information about a token in a secure way through our developer portal or API. The tool has been added to our developer portal and the documentation for the new Token Introspection Endpoint is available here.

  • Introducing allowedCampaignTypes field

    • Who's impacted: Partners using the adCampaignsGroupsV2 API.
    • What's happening: Field allowedCampaignTypes in adCampaignsGroupsV2 endpoint will be introduced only for accounts with type ENTERPRISE. The field allowedCampaignTypes will not be returned for accounts with type BUSINESS as all campaign types can be created within these accounts. Before creating new campaigns in Enterprise accounts, it is recommended to check allowedCampaignTypes. The array of allowedCampaignTypes can return the following campaign types:
      • TEXT_AD - Text-based ads that show up in the right column or top of the page on LinkedIn.
      • DYNAMIC - Ads that are dynamically personalized.
      • SPONSORED_UPDATES - Native ads that promote a company's content updates in the LinkedIn feed.
      • SPONSORED_INMAILS - Personalized messages with a call-to-action button delivered to LinkedIn's member inbox.

Message Ads

  • Conversations Ads Now Supported on Three New Objective Types
    • Who's impacted: Partners using Objective-Based Advertising
    • What's happening: Conversations Ads was previously only available as a format when choosing Lead Generation or Website Visits as an Objective. Now, you can select Conversation Ads for Brand Awareness, Engagement, and Website Conversion Objective Types.

Migrations

  • [Warning] Deprecation of totalBudget and totalBudgetEndsAt

    • Who's impacted: all partners using adAccountsV2
    • What's happening: totalBudget and totalBudgetEndAt field in adAccountsV2 will be deprecated starting October 30, 2020. All budget and run date information should be set and read at the Campaign Group level. totalBudget from adAccountsV2 maps to totalBudget in adCampaignsGroupsV2 and totalBudgetEndAt maps to runSchedule.end in adCampaignsGroupsV2.

  • [Optional to Required] campaignGroup field

    • Who's impacted: all partners using adCampaignsV2
    • What's happening: campaignGroup field in adCampaignsV2 endpoint will be a required field (currently is optional). Any campaign creation calls to the adCampaignsV2 endpoint that do not specify campaignGroup will fail and return a 400 starting October 30, 2020.

  • [Extension] Enforced projections for adAnalyticsV2

    • Who's impacted: Partners using the adAnalytics API.
    • What's happening: The adAnalyticsV2 API will require all callers to request only the metrics they need from the API by using the fields= parameter. There will also be an enforcement of 20 fields maximum per request.
    • When: We have extended the deadline by 60 days to September 30, 2020. After this date, any request without fields= will return a 400. Additionally any request asking for more than 20 fields will return a 400.

June 2020

General API

  • REMINDER: New error response schema
    • Who's impacted: Partners using the adCampaignsGroups and adCampaigns API
    • What's happening: To make error responses more actionable, we've introduced: new error response fields -- errorDetailType and errorDetails -- and updated HTTP status codes that will be specific to the error. Make sure you've parsed these fields and updated your error parsing logic to account for the new error fields and the updated HTTP codes, as necessary. Learn more.
  • Introducing Test Ad Accounts
    • Who's impacted: Partners using the adCampaigns API
    • What's happening: Use Test Ad Accounts to test new integrations in a sandbox environment, where no billing setup is required and you don't need to worry about LinkedIn members seeing your test ads. Learn more.

Optimization

  • Introducing Lifetime Pacing for campaigns using updated budget-schedule combinations.
    • Who's impacted: Partners using the adCampaigns API
    • What's happening: Lifetime Pacing spends the budget more efficiently by allocating for ad request traffic for the duration of the campaign. Advertisers no longer need to pause campaigns during times of predicted lower traffic, such as the weekends. Lifetime Pacing is available for Daily Budget + Fixed Schedule, Lifetime Budget, and Daily and Lifetime Budget options. Learn more.
  • Fix to resolve Message Ads campaign validation issue
    • Who's impacted: Partners using the adCampaigns API.
    • What's happening: You may have experienced a delay in delivery of some creatives when selecting 'Optimize for Performance' in your Message or Conversation Ad campaigns. This option has been removed from Sponsored Messaging. New validations will be added to ensure "creativeSelection" is "ROUND_ROBIN" for all creates and updates. For SPONSORED_INMAILS campaigns, make sure in new create/batch_create requests put "creativeSelection" = "ROUND_ROBIN"; For existing SPONSORED_INMAILS campaigns, make sure to update "creativeSelection", otherwise updating other fields will fail this validation. Learn more.
    • When: The validation will take effect on July 29. Please update your existing SPONSORED_INMAILS campaigns and make sure your newly created campaigns are valid.

Reporting

  • Data limit throttling for adAnalyticsV2
    • Who's impacted: Partners using the adAnalytics API.
    • What's happening: The /adAnalyticsV2 API will enforce a data limit over a 5 min window to protect LinkedIn API servers from being overwhelmed by a user requesting too much data. Learn more.
    • When: By August 31, 2020, We recommend partners to start using fields= parameter to reduce the query loads and spread the requests over a longer duration. After August 31, if a partner exceeds the limit, further requests from the partner will return 400 for the rest of the 5 min window.

Migrations

  • REMINDER: Enforced projections for adAnalyticsV2
    • Who's impacted: Partners using the adAnalytics API.
    • What's happening: The /adAnalyticsV2 API will require all callers to request only the metrics they need from the API by using the fields= parameter. There will also be an enforcement of 15 fields maximum per request.
    • When: We will require all partners to pass the fields= parameter by July 31, 2020. After that date, any request without fields= will return a 400. Additionally any request asking for more than 15 fields will return a 400.
  • Setting a deprecated targeting object will now throw an error
    • Who's impacted: Partners setting targeting object in adCampaignsV2 API.
    • What's happening: Setting the targeting object in your request will now throw an error. Please use targeting criteria instead. Learn more.

May 2020

General API

  • Introducing Test Ad Accounts
    • Who's impacted: Partners using the adCampaigns API.
    • What's happening: Use Test Ad Accounts to test new integrations in a sandbox environment, where no billing setup is required and you don't need to worry about LinkedIn members seeing your test ads. Learn more.
  • New error response schema
    • Who's impacted: Partners using the adCampaignGroupsV2 and adCampaigns API
    • What's happening: To make error responses more actionable, we're introducing: new error response fields -- errorDetailType and errorDetails -- and updated HTTP status codes that will be specific to the error. Make sure to check if you have parsed these fields and update your error parsing logic to account for the new error fields and the updated HTTP codes, as necessary. Learn more.
  • Fix to reduce errors when creating ads
    • Who's impacted: Partners using the adCampaigns API
    • What's happening: You may have previously observed an error if you created a post on LinkedIn and then immediately tried to sponsor it. This issue has been resolved.
  • Disabling 'Optimize for Performance' option
    • Who's impacted: Partner using the Message Ads or Conversations Ads API
    • What's happening: You may have experienced a delay in delivery of some creatives when selecting 'Optimize for Performance' in your Message or Conversation Ad campaigns. This option has been removed from Sponsored Messaging, so if you do select 'Optimize for Performance', you will be unable to create or update your campaign. Make sure creativeSelection = "ROUND_ROBIN" and not "OPTIMIZED" when creating your Message campaign. Learn more.

Conversions

  • Missing conversion data
    • Who's impacted: All reporting partners
    • What's happening: Due to delays in finalized daily conversion data, you may have noticed missing campaign performance metrics for May 13-14 and campaign demographic metrics for May 13-15. The issue has been resolved.
    • Action required: Please resync all conversions data between May 13-15.

April 2020

General API

  • Campaign Groups Campaign Creation Limit
    • Who's impacted: Partners using the adCampaignGroupsV2 endpoint.
    • What's happening: We have increased the limit from 200 to 1,000 campaigns per non-default campaign group. Learn more here
  • New ad format: square & vertical video ads
    • Who's Impacted: Partners using the Assets API and Video Ads.
    • What's happening: Create video ads with different aspect ratios (square 1:1 and vertical ads). Please use ads-video_v2, and no longer use ads-video. You can continue to use video formats. Note: vertical aspect ratio video ads will only be served to a mobile device player. Learn More

Bidding & Optimization

  • New bidding option - Target Cost Bidding
    • Who's impacted: Partners using the Ad Campaigns
    • What's happening: Target Cost Bidding is a new bidding option that provides advertisers with an additional way to optimize their campaigns and better manage costs. When choosing Target Cost, the campaign will be optimized to generate as many objective key results as possible, while maintaining a 30 percent upper and lower bound value specified by the advertiser. Learn More

Targeting

  • New firmographic facets available for targeting -- Company Growth & Company Categories
    • Who's impacted: Partners using the adTargetingEntities endpoint
    • What's happening: We have added two new firmographic facets: company growth and company categories allow you to target a curated list from well-recognized publications and thought leaders like Forbes, Fortune, and LinkedIn. Company growth measures year-over-year growth in employee count and an be used to reach companies in high growth and may be in need of a system or technology.

Migrations

  • Enforced projections for adAnalyticsV2
    • Who's impacted: Partners using the adAnalytics API
    • What's happening: The /adAnalyticsV2 API will require all callers to request only the metrics they need from the API by using the fields= parameter. There will also be an enforcement of 15 fields maximum per request.
    • When: We will require all partners to pass the fields= parameter by July 31, 2020. After that date, any request without fields= will return a 400 error. Additionally any request asking for more than 15 fields will return a 400 error.

Migrations

  • Geo-location targeting migration
    • Who's impacted: Partners using the Ad Targeting API location facet only. This does not impact the Share or UGC API.
    • What's happening: We have asked partners to complete their migration to Bing geo data

March 2020

General API

  • Asset API when uploading image to LinkedIn platform.
    • Who's impacted: Partners using the Asset API to Upload Image
    • What's happening: When registering an upload for images, specify "SYNCHRONOUS_UPLOAD" as supportedUploadMechanism in registerUploadRequest JSON to make sure an Image Asset is created when the ugcPost is created, so that the feed update can be rendered. Learn more.
  • Track and report Reaction on organic posts and Sponsored Content
    • Who's impacted: Partners that use Social Actions API
    • What's happening: Member reactions, such as likes, celebrate, love, insightful, curious, to organize and paid posts can now be accessed with the new Reactions and SocialMetadataAPIs. The Reactions endpoint provides reaction, creation, update, delete, and reads, while the SocialMetadata endpoint provides comment and reaction counts and metadata on posts. Learn more
    • Images+Comments capability availability via the Vector API
      • Who's impacted: Partners adding image in comments previously using the Rich Media API and migrating to the Vector API.
      • What's happening: Previously, you could add an image to comments via the Rich Media API but not with the new Vector API, which was blocking the migration.. This issue was resolved starting March 10. A new entity urn field was added to the content field, replacing the existing URL field. When creating a comment with an image, specify the image as an urn (obtained when uploading an image to the Vector API) instead of a URL. Learn more
      • Attaching images to comments by URL will not be supported after the Rich Media API is sunset. The URL will still be provided when reading comments, but note that this is an expiring URL.

Conversions & Reporting

  • [Fixing soon] Viral impressions/clicks for single-image Sponsored Content.
    • Who's impacted: Partners using adAnalyticsV2
    • What's happening:
      • If a Sponsored Content is commented or liked, it can be distributed to a member's network beyond the target audience. These are called viral impressions & viral clicks, which are free and not charged for. In reporting these metrics, start with the word "viral".
      • Historically, viral reporting counts for single-image Sponsored Content were not returned. Video and Carousel Ads are unaffected.
      • This will be fixed by April 30 in Ads Reporting. Historical performance data will not be backfilled. Learn more
  • Recommendations when retrieving large data sets.
    • Who's impacted: All partners trying to retrieve large data sets via adAnalyticsV2 API
    • What's happening: An ongoing problem when trying to retrieve large data sets (for example, adAnalyticsV2 endpoint with projection and demographic pivots) is a combination of 400 and 400 errors that too much data is being called. You can specify fields in the projection, but to reduce the content length limit in the response, you should limit the fields by adding &fields= to your request with the specific fields you want returned. Learn more.

      • Example:

        https://api.linkedin.com/v2/adAnalyticsV2?q=analytics&dateRange.start.year=2019&dateRange.start.month=9&dateRange.start.day=1&dateRange.end.year=2020&dateRange.end.month=1&dateRange.end.day=31&timeGranularity=ALL&accounts=urn%3Ali%3AsponsoredAccount%3A<account_id>&pivot=MEMBER_COMPANY&projection=(*,elements*(*,pivotValue~(localizedName)))&fields=dateRange,impressions,clicks,landingPageClicks,externalWebsiteConversions,pivotValue
  • Introducing Conversation Ads
    • Who's impacted: Partners using the Conversation Ads API
    • What's happening: On March 17, we launched a new messaging-based ad format, Conversation Ads. With this ad, advertisers will be able to add multiple, custom calls-to-action (CTAs) to each step of their conversation that generates automated responses. These responses can include showing a subsequent message, linking to a landing page, or opening up a LinkedInLead Gen Form. In-product templates will be available in early April. Learn more

Targeting

  • New targeting attributes to reach the right audience
  • Who's impacted: Partners using the adTargetingEntities API
  • What's happening: We have released 10 new targeting attributes, based on known characteristics and behaviors (i.e., frequent traveler, iOS user, Android user, desktop user, open to jobs, open to education), to help you reach the audiences that matter. Learn more

February 2020

General API Updates

  • Images+Comments capability via the Vector API will be available on March 10

    • Who's impacted: Partners adding an image in comments previously using the Rich Media API and migrating to the Vector API
    • What's happening: Previously, you could add an image to comments via the Rich Media API, but not with the new Vector API which was blocking the migration. This issue will be resolved on March 10.

  • An entity field is now part of the content field in a comment, replacing the url field. When creating a comment with an image, specify the image as a digitalmediaAsset URN (obtained when uploading an image to the Vector API) within the entity field instead of the URL field. Learn more

    • Attaching images to comments by URL will not be supported after the Rich Media API is retired. The URL will still be provided when reading comments, but this will only be an expiring URL.

  • REMINDER: UGCPosts thumbnail, originalURL, and description fields must be empty when creating video, live video, and document posts

    • Who's impacted: Partners using UGC API
    • What's happening: Previously, you may have leveraged the thumbnail, originalURL, or description field when creating a video, live video, or document post where the UgcPosts's shareMediaCategory field is either VIDEO, LIVE_VIDEO, or NATIVE_DOCUMENT. These fields are meant for third-party articles, and not for the above posts. We did not activate the appropriate validations to prevent such calls. Starting February 28, we will be enforcing these validations, so please ensure these fields are blank when creating the above posts, otherwise the call will result in a 400 error. For creating UGCPosts with ShareMediaCategory of URN_Reference, the title, description, originalUrl, mediaOverlay, and thumbnail fields must be empty.

Community Management

  • New field to look up organization type
    • Who's impacted: Partners using the Organization Lookup API.
    • What's happening: New primaryOrganizationType field enables you to easily look up the primary organization type: school, brand, or none. Learn more.

Migrations

  • REMINDER: Geo-location targeting migration

    • Who's impacted: Partners using the Ad Targeting API location facet only. This does not impact the Share or UGC API.
    • What's happening: In an effort to improve our geo targeting and provide a more comprehensive targeting experience, LinkedIn is migrating to Bing geo data. Refer to this Migration Guide for additional detail.
    • When:; By March 31, 2020, partners should stop using the Locations APIs, and instead integrate with our adTargetingEntities Typeahead and Urns APIs. Starting April 1, 2020, the legacy locations will no longer be accepted in campaign creation.

  • REMINDER: Upload images via the new API.

    • Who's impacted: Partners using the Rich Media API
    • What's happening: Use a new API to upload images for organic posts and Sponsored Content. The new API, called Vector, supports higher resolution images and faster image upload times. We are extending the removal date for the Rich Media API from January 30 to May 31, 2020.
    • When: Migrate to the new API for image uploads by May 31, 2020, to avoid disruptions to your service.

Migrations

  • REMINDER: Member Company Pivot Name change
    • Who's impacted: Partners using the adAnalyticsV2 API
    • What's happening: The format of pivotValue values in the response to requests using the pivot(s) MEMBER_COMPANY will change from company urn (urn:li:company:1) to organization urn (urn:li:organization:1). Those leveraging this pivot will need to use the Organization API to resolve the new organization urn.
    • When: The company URN will be removed on February 27, 2020.

January 2020

General API Updates

  • Updated API error messages to provide the most relevant information to help you troubleshoot
    • Who's impacted: All partners
    • What's happening: Error messages have been updated to provide the specific information you need to fix errors and make it easier to use our APIs. This is the first step in a long-term plan to improve our error schema, which includes a new error detail field to provide additional information. Look for more details in the coming months.
  • Changes to rw_company_admin, r_basicprofile, r_emailaddress, and w_share permissions.
    • Who's impacted: Partners requesting member authorization for rw_company_admin, r_basicprofile, r_emailaddress or w_share
    • What's happening: Previously, you were able to access the following four permissions without approval: rw_company_admin, r_basicprofile, r_emailaddress and w_share. Starting February 27, 2020, you can only request these permissions if they are permissions granted to your application and visible as an available permission under the Auth tab in the Developer Portal. Requesting permissions that your application does not have will result in an error (unauthorized_scope_error) thrown during OAuth authorization.
  • UGCPosts thumbnail, originalURL, and description fields must be empty when creating video, live video, and document posts.
    • Who's impacted: Partners using the UGC API
    • What's happening: Previously, you may have leveraged the thumbnail, originalURL, or description fields when creating a video, live video, or document post where the UgcPost's shareMediaCategory field is either VIDEO, LIVE_VIDEO, or NATIVE_DOCUMENT. These fields are meant for third-party articles, and not for the above posts. We did not activate the appropriate validations to prevent such calls. Starting February 28, we will be enforcing these validations, so please ensure these fields are blank when creating the above posts, otherwise the call will result in a 400 error.
    • For creating UGCPosts with ShareMediaCategory of URN_REFERENCE, the title, description, originalUrl, mediaOverlay and thumbnail fields must be empty.
  • Updates to the Breaking Change policy
    • Who's impacted: All partners
    • What's happening: A new Breaking Change Policy article has been added to developer documentation. Please review this guide to understand how LinkedIn defines and manages breaking changes.

Conversions & Reporting

  • New field: Approximate unique impressions
    • Who's impacted: Partners using the adAnalytics V2 API
    • What's happening: Starting February 27, use a new field, Approximate Unique Impressions, to enhance your reporting. Learn More

Lead Gen Forms

  • Edit most components of live Lead Gen Forms
    • Who's impacted: Partners that use the Lead Gen Form API
    • What's happening: You can now edit Lead Gen Forms (LGF) attached to creatives under a non-draft campaign, with the exception of forms attached to Sponsored InMail or Conversation Ads. This includes the form headline, form details, form description, thank you message, thank you page CTA, link to website, privacy policy URL, and custom privacy policy text. Learn more.
  • Sponsored InMail rebranded to Message Ads
    • Who's impacted: All partners
    • What's happening: "Sponsored InMail" is now labeled as "Message Ad". We have updated our API docs to reflect the new product name.

Migrations

  • Geo-location targeting migration reminder
    • Who's impacted: Partners using the Ad Targeting API location facet only. This does not impact Share or UGC API.
    • What's happening: In an effort to improve our geo targeting and provide a more comprehensive targeting experience, LinkedIn is migrating to Bing geo data. Refer to this Migration Guide for additional detail.
    • When: By March 31, 2020, partners should stop using the Locations APIs, and instead integrate with our adTargetingEntities Typeahead and Urns APIs. Starting April 1, 2020, the legacy locations will no longer be accepted in campaign creation.
  • Upload images via the new API
    • Who's impacted: Partners using the Rich Media API
    • What's happening: Use a new API to upload images for organic posts and Sponsored Content. The new API, called Vector, will support higher resolution images and faster image upload times. We are extending the removal date for the Rich Media API from January 30 to March 30, 2020.
    • When: Migrate to the new API for image uploads by March 30, 2020 to avoid disruptions to your service.

Migrations

  • Member Company Pivot Name Change
    • Who's impacted: Partners using the adAnalytics V2 API
    • What's happening: The format of pivotValue(s) in the response of requests using the pivot(s) MEMBER_COMPANY will change from company urn (urn:li:company:1) to organization urn (urn:li:organization:1). Those leveraging this pivot will need to use the Organization API to resolve the new organization urn. When: Company urn will be removed on February 27, 2020.