Post Schema

Field Format Description Required
author Person or Organization URN Author of the post (can be either posted as member or their company page). create-only required
adContext adContext type The advertising context representing the ads specific metadata (which is related to ads or viral tracking, rendering, etc.), associated with the post. The current usage is for viral posts created from an ad and dark posts. If not set, then the post doesn't have ad specific metadata. optional
commentary little text The user generated commentary for the post. required
container URN Container Entity URN that contains user generated content. If not set, the post doesn't belong to a container. optional
content content type The posted content (if any, e.g., video). Optional content indicates a post with only commentary. optional
contentLandingPage URL Web page that's opened when the member clicks on the associated content. For example, clicking on an image and then linking and taking the user to an associated web page. If empty, no landing page associated with the content. This field is ignored in Campaign Manager UI for article ads and doesn't map to Destination URL field. Required if the campaign creative has the WEBSITE_VISIT objective - otherwise optional
contentCallToActionLabel Type of ContentCallToActionLabel which has the values of:
  • APPLY - Call To Action button on the creative shows Apply.
  • DOWNLOAD - Call To Action button on the creative shows Download.
  • VIEW_QUOTE - Call To Action button on the creative shows View Quote.
  • LEARN_MORE - Call To Action button on the creative shows Learn More.
  • SIGN_UP - Call To Action button on the creative shows Sign Up.
  • SUBSCRIBE - Call To Action button on the creative shows Subscribe.
  • REGISTER - Call To Action button on the creative shows Register.
  • JOIN - Call To Action button on the creative shows Join.
  • ATTEND - Call To Action button on the creative shows Attend.
  • REQUEST_DEMO - Call To Action button on the creative shows Register Demo.
  • SEE_MORE - Call To Action button on the creative shows See More.
  • BUY_NOW - Call To Action button on the creative shows Buy Now. Note: This value is supported only for API Versions starting from 202504 and later.
  • SHOP_NOW - Call To Action button on the creative shows Shop Now.
    Note: This value is supported only for API Versions starting from 202504 and later.
The call to action label which a member can act upon that's associated with the content. If empty, there's an optional call to action associated with the content. optional
createdAt Time at which the resource was created in milliseconds since epoch. Time read-only
distribution distribution Type Distribution of the post both in LinkedIn and externally create-only required
id Unique ID for the object. Can contain more URN types (in development) ugcPostUrn or shareUrn read-only
isReshareDisabledByAuthor boolean default=false Indicates whether resharing of the post has been disabled by the author. If this field is set to true, the post can't be reshared in any context. If false, other reshare restrictions may still apply due to the post's visibility, container, or content type. optional
lastModifiedAt Time at which the resource was last modified in milliseconds since epoch. Time read-only
lifecycleState The state of the content. PUBLISHED is the only accepted field during creation. The following values can be returned in responses:
  • DRAFT - Represents content that's accessible only to the author and is not yet published.
  • PUBLISHED - Represents content that's accessible to all entities. This is the only accepted field during creation.
  • PUBLISH_REQUESTED - Represents content that has been submitted for publishing but is not yet ready for rendering. The content will be published asynchronously once the processing has successfully completed.
  • PUBLISH_FAILED - Represents content that has been submitted for publishing but was not processed. An edit is required in order to re-attempt publishing.
Enum string required
lifecycleStateInfo optional lifecycleStateInfo Additional information about the lifecycle state for PUBLISH_REQUESTED or PUBLISH_FAILED. optional
publishedAt The time at which the content was published represented in epoch time. long Optional
reshareContext optional reshareContext The context in which the post was re-shared - only be set for re-shares. This field contains information about the reshare context:
  • parent: URN type the direct parent of the post (i.e.,the post that was re-shared).
  • root: The greatest ancestor of the post - may also be the parent. This field is derived from the parent and supports the same URN types. root is read-only.
optional
visibility Visibility restrictions on content. Type of MemberNetworkVisibility with the following values:
  • CONNECTIONS - Represents 1st degree network of owner.
  • PUBLIC - Anyone can view this.
  • LOGGED_IN - Viewable by logged in members only.
  • CONTAINER - Visibility is delegated to the owner of the container entity. For example, posts within a group are delegated to the groups authorization API for visibility authorization.
MemberNetwork Visibility required

adContext

Represents the ads specific metadata (related to ads or viral tracking, rendering, etc.), associated with the post.

Field Format Description Required
dscAdAccount Sponsored Account URN The Ad Account that created the Direct Sponsored Content (DSC). Read-only. This field is required when isDsc is true, optional otherwise.
dscAdType String, Type of the content The type of DSC (e.g. VIDEO, STANDARD, CAROUSEL, etc.). Read-only. This field is required when isDsc is true, optional otherwise.
dscName String Plain text name of the DSC post. Only applicable for DSC. If isDSC is true and dscName is empty, it has an optional name. Optional
dscStatus String The status of the advertising company content. Representing whether the content is usable from the advertiser's perspective as a DSC. This field is required when isDsc is true; optional otherwise.
isDsc boolean Whether or not this post is DSC. A posted DSC is created for the sole purpose of sponsorship. Read-only. optional

dscAdType

The post's ad content type.

Enumeration Name Description
VIDEO Contains video content.
STANDARD Contains single image, text, or article.
CAROUSEL Contains carousel. Post contains a reference to a collection where the collection can only be images.
JOB_POSTING Contains single content containing a LinkedIn job posting.
NATIVE_DOCUMENT Contains native document uploaded to LinkedIn. The following file types are supported:
  • PPT
  • PPTX
  • DOC
  • DOCX
  • PDF.
EVENT Contains single content containing a LinkedIn event.

dscStatus

Enables you to toggle the status of the advertising company content. It indicates whether the content is usable from the advertiser's perspective.

Enumeration Name Description
ACTIVE The content can be served.
ARCHIVED The content is inactive and not intended for use, its creatives are cancelled. Archiving currently can't be undone

Content

Field Format Description
media MediaContent Details of the Media content such as Image, Video.
poll PollContent Details of Poll content (can only be non-sponsored).
multiImage MultiImageContent Details of MultiImage content (can only be non-sponsored).
article ArticleContent Details of Article content (can be either non-sponsored or sponsored).
carousel CarouselContent Details of Carousel content (Can only be sponsored).
celebration CelebrationContent Details of Celebration content (can only be non-sponsored and currently, celebration post can't be created through external api).
reference ReferenceContent Details of Reference content like event and appreciation.

Reference

Field Format Description
id URN The URN of the reference that represents a reference such as an event (e.g. urn:li:reference:123).

Media

Field Format Description
id URN The URN of the media such as image or video.
title String The media title (Required field for Documents API).
altText String The alternate text for the media. None if empty. Optional.

distribution

Field Format Description
feedDistribution feedDistribution type Specifies the feeds distributed to within LinkedIn.
  • NONE-Do not distribute within LinkedIn via feed.
  • MAIN_FEED-Distribute to the flagship feed, and container entity feed if applicable.
targetEntities Optional target Intended audience for this post. The target entities targeted for distribution. The distribution is an OR of the targets in the array.
thirdPartyDistributionChannels Optional External distribution channels that this post is distributed to (e.g., Twitter, Tencent, Weibo). Empty array indicates the post is not externally distributed.

targetEntities

Field Sub-Field Format Description
targetedEntities Entities targeted for distribution. Structured as an object containing multiple arrays of targeting entity URNs that function like a series of OR conditionals. Array of Targets (refer the following)
degrees Standardized degrees to be targeted. Array of Degree URN
fieldsOfStudy Standardized fields of study to be targeted. Array of FieldOfStudy URN
industries Industries to be targeted. Array of Industry URN
interfaceLocales Interface locales to be targeted. Array of Locale
jobFunctions Top level groupings of super titles to be targeted. Array of Function URN
locations Deprecated. Use geoLocations field instead for the targeting location. URNs can be: countryGroup, country, state, and region Array of Location URN
geoLocations GeoLocations for targeting. Array of Geo URN Learn more
schools Deprecated. Use organizations field instead. Standardized schools for targeting. Array of School URN
organizations School organizations for targeting. Retrieve a school organization URN using the Organization Lookup API Array of Organization URN
seniorities Seniorities to be targeted. Array of Seniority URN
staffCountRanges Organization sizes for targeting. Consists of the following enum values:
  • SIZE_1
  • SIZE_2_TO_10
  • SIZE_11_TO_50
  • SIZE_51_TO_200
  • SIZE_201_TO_500
  • SIZE_501_TO_1000
  • SIZE_1001_TO_5000
  • SIZE_5001_TO_10000
  • SIZE_10001_OR_MORE
Array of StaffCountRange

Note

The audience you target for your share must be greater than 300 members. See Create Targeted Organic Posts for more information.

lifecycleStateInfo

This section provides additional information about the lifecycle state.

Field Format Description
contentStatus optional ProcessingState Status for post content. If absent, then state doesn't wait for content processing. PENDING, PROCESSING, and FAILED are available values. If processing completes UGC transitions to PUBLISHED and the contentStatus is null.
isEditedByAuthor boolean
default=false Indicates whether a post was edited by the author after publishing. Applicable for UserGeneratedContentLifecycleState value of PUBLISHED only.
reviewStatus optional ProcessingState Review status of the post. If not present, then the state doesn't wait upon review. PENDING, PROCESSING, and FAILED are the possible values for this field. If processing completes the UGC transitions to PUBLISHED and reviewStatus is null. Applicable for lifecycle state values of PUBLISH_REQUESTED and PUBLISHED_FAILED only.