Overview
- POST /rest/inMailContents/
- GET /rest/inMailContents/{adInMailContentId}
- POST /rest/inMailContents/{adInMailContentId}
- PARAMETERS /rest/inMailContents/{adInMailContentId}
- GET /rest/inMailContents
- POST /rest/inMailContents
- PUT /
- GET /images
- POST /images
- GET /rest/images/{image_urn}
- PARAMETERS /rest/images/{image_urn}
- GET /rest/images
- GET /rest/posts
- GET /rest/posts/{postId}
- PARAMETERS /rest/posts/{postId}
- POST /videos
- GET /images/{image_urn}
- PARAMETERS /images/{image_urn}
- GET /creatives
- POST /creatives
- GET /creatives/{urn_creatives}
- PARAMETERS /creatives/{urn_creatives}
- POST /creatives/{creative ID}
- DELETE /creatives/{creative ID}
- PARAMETERS /creatives/{creative ID}
- GET /posts
- POST /posts
- shareUrn}
- shareUrn}
- shareUrn}
- POST /posts/{shared ID}/{ugcPosts ID}
- PARAMETERS /posts/{shared ID}/{ugcPosts ID}
- GET /conversationAds
- POST /conversationAds
- GET /conversationAds/{conversationUrn}
- POST /conversationAds/{conversationUrn}
- PARAMETERS /conversationAds/{conversationUrn}
- POST /conversationAds/{conversationAdsId}/sponsoredMessageContents
- PARAMETERS /conversationAds/{conversationAdsId}/sponsoredMessageContents
- GET /conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
- POST /conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
- PARAMETERS /conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
- GET /conversationAds/{conversationUrn}/sponsoredMessageContents
- POST /conversationAds/{conversationUrn}/sponsoredMessageContents
- DELETE /conversationAds/{conversationUrn}/sponsoredMessageContents
- PARAMETERS /conversationAds/{conversationUrn}/sponsoredMessageContents
- GET /creatives/{sponsoredCreative-urn}
- POST /creatives/{sponsoredCreative-urn}
- DELETE /creatives/{sponsoredCreative-urn}
- PARAMETERS /creatives/{sponsoredCreative-urn}
- POST /documents
- GET //documents/{document_asset_id}
- PARAMETERS //documents/{document_asset_id}
POST /rest/inMailContents/
Summary: Create InMail Content
API to create an inMail Content.
OpenAPI snippet URL
GET /rest/inMailContents/{adInMailContentId}
Summary: Get InMail Content
API to retrieve an inMail Content.
OpenAPI snippet URL
POST /rest/inMailContents/{adInMailContentId}
Summary: Update InMail Content
API to update an inMail Content.
OpenAPI snippet URL
PARAMETERS /rest/inMailContents/{adInMailContentId}
OpenAPI snippet URL
GET /rest/inMailContents
Summary: Batch Get InMail Content
API to retrieve an inMail Content in Batches.
OpenAPI snippet URL
POST /rest/inMailContents
Summary: Send Test InMail
API to send/share an inMail Content.
OpenAPI snippet URL
PUT /
Summary: Upload an Image
This is a generic Upload URL call without init.
OpenAPI snippet URL
GET /images
Summary: Get Multiple Videos
This API retrieves multiple videos.
OpenAPI snippet URL
POST /images
Summary: Initialize Image Upload
Use the initializeUpload action to register the upload. When you initialize, you declare the upcoming upload. Use the upload URL to upload the image.
OpenAPI snippet URL
GET /rest/images/{image_urn}
Summary: Get a single Image
This API rerieve a single image.
OpenAPI snippet URL
PARAMETERS /rest/images/{image_urn}
OpenAPI snippet URL
GET /rest/images
Summary: Get Multiple Images
This API rerieve multiple images.
OpenAPI snippet URL
GET /rest/posts
Summary: Create Image Content
This API creates an image content.
OpenAPI snippet URL
GET /rest/posts/{postId}
Summary: Get Image Content
This API rerieve the content associated with a single image.
OpenAPI snippet URL
PARAMETERS /rest/posts/{postId}
OpenAPI snippet URL
POST /videos
Summary: Initialize Video Upload
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.
OpenAPI snippet URL
GET /images/{image_urn}
Summary: Get a single video
This API retrieves a single video.
OpenAPI snippet URL
PARAMETERS /images/{image_urn}
OpenAPI snippet URL
GET /creatives
Summary: Search for Creative
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).
OpenAPI snippet URL
POST /creatives
Summary: Create an Organic Creative
You can sponsor an existing organic post that has been serving your company page followers and gone viral.
OpenAPI snippet URL
GET /creatives/{urn_creatives}
Summary: Get a Sponsored Creative
Get a Sponsored Creative
OpenAPI snippet URL
PARAMETERS /creatives/{urn_creatives}
OpenAPI snippet URL
POST /creatives/{creative ID}
Summary: Update a Creative
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.
OpenAPI snippet URL
DELETE /creatives/{creative ID}
Summary: Delete a Creative
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.
OpenAPI snippet URL
PARAMETERS /creatives/{creative ID}
OpenAPI snippet URL
GET /posts
Summary: Get Multiple Post by URN
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.
OpenAPI snippet URL
POST /posts
Summary: Create Organic Post
Simplest form of post creation where an organic post is made ith a sample text at a page.
OpenAPI snippet URL
GET /posts/{encoded ugcPostUrn|shareUrn}
Summary: Get Posts by 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 API for instructions on how to do this.
OpenAPI snippet URL
DELETE /posts/{encoded ugcPostUrn|shareUrn}
Summary: Delete a Post
Post deletions are idempotent. Deletion requests for a previously deleted UGC Post will return a 204 code - No Content.
OpenAPI snippet URL
PARAMETERS /posts/{encoded ugcPostUrn|shareUrn}
OpenAPI snippet URL
POST /posts/{shared ID}/{ugcPosts ID}
Summary: Update a Post
The following posts field are available to update. Refer to Schema for complete field details.
| Field | Description |
|---|---|
| commentary | String |
| contentCallToActionLabel | contentCallToActionLabel text |
| contentLandingPage | URL of the landing page |
| reshareContext | |
| lifecycleState | |
| adContext | * dscName: Update the name of the sponsored content * dscStatus: Update the status of the sponsored content |
OpenAPI snippet URL
PARAMETERS /posts/{shared ID}/{ugcPosts ID}
OpenAPI snippet URL
GET /conversationAds
Summary: Get Multiple Sponsored Conversations
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":
{
"id": "urn:li:sponsoredConversation:703695",
"parentAccount": "urn:li:sponsoredAccount:520866471",
}
},
"errors": {}
}
OpenAPI snippet URL
POST /conversationAds
Summary: Create a Sponsored Conversation
Successful response will have Status 201 Created and the ID in the x-linkedin-id response header. For example,urn:li:sponsoredConversation:164380864
OpenAPI snippet URL
GET /conversationAds/{conversationUrn}
Summary: Get a Sponsored Conversation
Sample Response
JSONCopy
{
"id": "urn:li:sponsoredConversation:185204",
"parentAccount": "urn:li:sponsoredAccount:520866471"
}
OpenAPI snippet URL
POST /conversationAds/{conversationUrn}
Summary: Update a Sponsored Conversation
In the following example, the firstMessageContent field is changed to point to the first message of the conversation.
OpenAPI snippet URL
PARAMETERS /conversationAds/{conversationUrn}
OpenAPI snippet URL
POST /conversationAds/{conversationAdsId}/sponsoredMessageContents
Summary: Create Sponsored Message Content
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)".
OpenAPI snippet URL
PARAMETERS /conversationAds/{conversationAdsId}/sponsoredMessageContents
OpenAPI snippet URL
GET /conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
Summary: Get Sponsored Message Content
Retrieves just a single message content from all the conversations in a conversation Ad.
OpenAPI snippet URL
POST /conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
Summary: Update Sponsored Message Content
Updates the message contents from all the conversations in a conversation Ad.
OpenAPI snippet URL
PARAMETERS /conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
OpenAPI snippet URL
GET /conversationAds/{conversationUrn}/sponsoredMessageContents
Summary: Get All Sponsored Message Content
Retrieves just all the message contents from all the conversations in a conversation Ad.
OpenAPI snippet URL
POST /conversationAds/{conversationUrn}/sponsoredMessageContents
Summary: Batch update Sponsored Message Content
Updates Sponsored Message Content in Batches.
OpenAPI snippet URL
DELETE /conversationAds/{conversationUrn}/sponsoredMessageContents
Summary: Batch delete Sponsored Message Content
Deletes Sponsored Message Content in Batches.
OpenAPI snippet URL
PARAMETERS /conversationAds/{conversationUrn}/sponsoredMessageContents
OpenAPI snippet URL
GET /creatives/{sponsoredCreative-urn}
Summary: Get a Dynamic Follower Ad
Retrieves a dynamic follower ad after passing an urn.
A successful response returns a HTTP 200 status code.
OpenAPI snippet URL
POST /creatives/{sponsoredCreative-urn}
Summary: Update a Dynamic Follower Ad
Updates a dynamic follower ad after passing an urn.
A successful response returns a 204 No Content HTTP status code.
OpenAPI snippet URL
DELETE /creatives/{sponsoredCreative-urn}
Summary: Delete a Dynamic Follower Ad
Updates a dynamic follower ad after passing an urn.
A successful response returns a 204 No Content.
OpenAPI snippet URL
PARAMETERS /creatives/{sponsoredCreative-urn}
OpenAPI snippet URL
POST /documents
Summary: Initialize Document Upload
Initialize Document Upload
OpenAPI snippet URL
GET //documents/{document_asset_id}
Summary: Get a single document
Get a single document
OpenAPI snippet URL
PARAMETERS //documents/{document_asset_id}
OpenAPI snippet URL