Version 1
Connector Overview: This page documents all 39 actions for the Linkedinconnector v1.
Creatives (4)
DELETE Delete a Creative
/creatives/{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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a Sponsored Creative
/creatives/{urn_creatives}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Search for Creative
/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).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a Creative
/creatives/{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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Image Ad (5)
GET Fetch multiple Image Content
/rest/posts
This API rerieve content from multiple images.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Image Content
/rest/posts/{postId}
This API rerieve the content associated with a single image.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Multiple Images
/rest/images
This API rerieve multiple images.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a single Image
/rest/images/{image_urn}
This API rerieve a single image.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Initialize Image Upload
/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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
InMail Content (5)
GET Batch Get InMail Content
/rest/inMailContents
API to retrieve an inMail Content in Batches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create InMail Content
/rest/inMailContents/
API to create an inMail Content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Get InMail Content
/rest/inMailContents/{adInMailContentId}
API to retrieve an inMail Content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Send Test InMail
/rest/inMailContents
API to send/share an inMail Content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update InMail Content
/rest/inMailContents/{adInMailContentId}
API to update an inMail Content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Posts (6)
POST Create Organic Post
/posts
Simplest form of post creation where an organic post is made ith a sample text at a page.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create a text post with url and image
/shares
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete a Post
/posts/{encoded ugcPostUrn|shareUrn}
Post deletions are idempotent. Deletion requests for a previously deleted UGC Post will return a 204 code - No Content.
####
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Find post by Account
/posts
You can retrieve all posts with the specific Sponsored Account and the content types with the following parameters:
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Posts by URN
/posts/{encoded ugcPostUrn|shareUrn}
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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a Post
/posts/{shared ID}/{ugcPosts ID}
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
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Sponsored Conversations (4)
POST Create a Sponsored Conversation
/conversationAds
Successful response will have Status 201 Created and the ID in the x-linkedin-id response header. For example,urn:li:sponsoredConversation:164380864
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Multiple Sponsored Conversations
/conversationAds
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": {}
}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a Sponsored Conversation
/conversationAds/{conversationUrn}
Sample Response
JSONCopy
{
"id": "urn:li:sponsoredConversation:185204",
"parentAccount": "urn:li:sponsoredAccount:520866471"
}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a Sponsored Conversation
/conversationAds/{conversationUrn}
In the following example, the firstMessageContent field is changed to point to the first message of the conversation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Sponsored Message Contents (6)
POST Batch create Sponsored Message Content
/conversationAds/{conversationAdsId}/sponsoredMessageContents
Creates Sponsored Message Content in Batches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Batch delete Sponsored Message Content
/conversationAds/{conversationUrn}/sponsoredMessageContents
Deletes Sponsored Message Content in Batches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Batch get Sponsored Message Content
/conversationAds/{conversationUrn}/sponsoredMessageContents
Retrieves Sponsored Message Content in Batches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Batch update Sponsored Message Content
/conversationAds/{conversationUrn}/sponsoredMessageContents
Updates Sponsored Message Content in Batches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Get Sponsored Message Content
/conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
Retrieves just a single message content from all the conversations in a conversation Ad.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Sponsored Message Content
/conversationAds/{conversationUrn}/sponsoredMessageContents/{messageUrn}
Updates the message contents from all the conversations in a conversation Ad.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Spotlight Ad (4)
POST Create a Dynamic Spotlight Ad
/creatives
Creates a Dynamic Spotlight Ad Creative.
A successful response returns a 201 Created HTTP status code and the ID in the x-linkedin-id response header. For example, urn:li:sponsoredCreative:123456789
##
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete a Dynamic Spotlight Ad
/creatives/{sponsoredCreative-urn}
Delete a Dynamic Spotlight Ad Creative
\* http
\* curl
HTTPCopy
DELETE https://api.linkedin.com/rest/creatives/{sponsoredCreative-urn}
A successful response returns a 204 No Content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a Dynamic Spotlight Ad
/creatives/{sponsoredCreative-urn}
Retrives a Dynamic Spotlight Ad.
Sample Response
JSONCopy
{
"servingHoldReasons": [
"UNDER_REVIEW",
"CAMPAIGN_STOPPED"
],
"lastModifiedAt": 1648512200000,
"lastModifiedBy": "urn:li:member:123",
"content": {
"spotlight": {
"organizationName": "LinkedIn Demo",
"showMemberProfilePhoto": true,
"landingPage": "http://linkedin.com",
"description": "Check out this demo",
"logo": "urn:li:image:abc",
"headline": "Spotlight Ad Demo",
"callToAction": "Join Us Now"
}
},
"createdAt": 1648512200000,
"createdBy": "urn:li:member:123",
"isTest": false,
"review": {
"status": "PENDING"
},
"isServing": false,
"campaign": "urn:li:sponsoredCampaign:123",
"id": "urn:li:sponsoredCreative:123456789",
"intendedStatus": "ACTIVE",
"account": "urn:li:sponsoredAccount:123"
}
##
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update a Dynamic Spotlight Ad
/creatives/{sponsoredCreative-urn}
Update a Dynamic Spotlight Ad Creative
\* http
\* curl
HTTPCopy
POST https://api.linkedin.com/rest/creatives/{sponsoredCreative-urn}
JSONCopy
{
"patch": {
"$set": {
"content": {
"spotlight": {
"callToAction": "New Action",
"description": "New Description",
"headline": "New Headline",
"landingPage": "http://example.com",
"organizationName": "New Organization Name",
"logo": "urn:li:image:def",
"showMemberProfilePhoto": false
}
}
}
}
}
A successful response returns a 204 No Content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
User
GET Retrieve my user id
/me
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Video Ad (4)
GET Get Multiple Videos
/images
This API retrieves multiple videos.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a single video
/images/{image_urn}
This API retrieves a single video.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Initialize Video Upload
/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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Upload a Video
/
This is a generic API to upload the data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |