Text Ads API

2025-06-04

Warning

Deprecation Notice
The Marketing Version 202406 (Marketing June 2024) has been sunset. We recommend that you migrate to the latest versioned 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.

You can create and manage Text Ads with the external Creatives API. Text ads include a headline, brief text, and an image. You can place them on the right rail of various LinkedIn desktop pages.

Requirements

For creation of Text ads, the following requirements must be met. See Text Ads Specifications.

Permissions

Permission	Description
`rw_ads`	Manage and read an authenticated member's Ad Accounts. To sponsor a image, the authenticated member must meet both of the following conditions: Be an ADMINISTRATOR of a Company Page or a DIRECT_SPONSORED_CONTENT_POSTER with access to Campaign Manager. Have one of the following Ad Account roles: `ACCOUNT_BILLING_ADMIN`,`ACCOUNT_MANAGER`, `CAMPAIGN_MANAGER`, `CREATIVE_MANAGER`
`r_ads`	Read an authenticated member's Ad Account. Restricted to Ad Accounts in which the authenticated member has one of the following Ad Account roles. `ACCOUNT_BILLING_ADMIN` `ACCOUNT_MANAGER` `CAMPAIGN_MANAGER` `CREATIVE_MANAGER` `VIEWER`

Schema

Note

Starting 202410, a new name field is introduced in Creative schema. Going forward, this new name field is the preferred approach to set and get the creative's name, consistently across all ad formats.

Schema for entire creative is similar to Creatives, only the content field now supports a Text Ad content for the creation and management of Text Ads.

Schema for Text Ad Content is as follows:

Field	Type	Details	Required
description	string	The description that provides more information about the ad. Use up to 75 characters, including spaces.	Yes
headline	string	The main message seen by the target audience on the ad. Use up to 25 characters, including spaces	Yes
image	ImageUrn	Image uploaded by the advertiser, size is 100 x 100 pixels and <= 2MB, format is either a JPG or PNG file. If empty, there is none	No
landingPage	URL	The URL where the member should be redirected to, on clicking the text ad.	yes

POST https://api.linkedin.com/rest/creatives

{
    "content": {
      "textAd": {
        "landingPage": "https://lnkd.in/eabXpqi",
        "headline": "prod test headline",
        "description": "prod test description",
        "image": "urn:li:image:C4E22AQGX_uq7mQBfAA"
      }
    },
    "campaign": "urn:li:sponsoredCampaign:191989474",
    "intendedStatus": "ACTIVE"
}

curl --location POST -v 'https://api.linkedin.com/rest/creatives' \
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'Content-Type: application/json' \
-H 'X-Restli-Protocol-Version: 2.0.0' 
--data '{
    "content": {
      "textAd": {
        "landingPage": "https://lnkd.in/eabXpqi",
        "headline": "prod test headline",
        "description": "prod test description",
        "image": "urn:li:image:C4E22AQGX_uq7mQBfAA"
      }
    },
    "campaign": "urn:li:sponsoredCampaign:191989474",
    "intendedStatus": "ACTIVE"
}'

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:164380864

Get a Text Ad

http
curl

GET https://api.linkedin.com/rest/creatives/{sponsoredCreativeUrn}

curl --location --request GET 'https://api.linkedin.com/rest/creatives/{sponsoredCreativeUrn}' \ 
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'Authorization: Bearer {INSERT_TOKEN}'

Replace the sponsoredCreativeUrn parameter with an URL encoded valid urn which will look like urn%3Ali%3AsponsoredCreative%3A123456

Sample Response

{
   "servingHoldReasons": [
       "UNDER_REVIEW",
       "ACCOUNT_SERVING_HOLD"
   ],
   "lastModifiedAt": 1650828926000,
   "lastModifiedBy": "urn:li:system:0",
   "content": {
       "textAd": {
           "image": "urn:li:image:C4E22AQGX_uq7mQBfAA",
           "description": "prod test description",
           "headline": "prod test headline",
           "landingPage": "https://lnkd.in/eabXpqi"
       }
   },
   "createdAt": 1650828923000,
   "isTest": false,
   "createdBy": "urn:li:person:B1U4S2MZ-C",
   "review": {
       "status": "NEEDS_REVIEW"
   },
   "isServing": false,
   "campaign": "urn:li:sponsoredCampaign:191989474",
   "id": "urn:li:sponsoredCreative:170811644",
   "intendedStatus": "ACTIVE",
   "account": "urn:li:sponsoredAccount:508915158"
}

Update a Text Ad

http
curl

POST https://api.linkedin.com/rest/creatives/{sponsoredCreativeUrn}

{
"patch": {
       "$set": {
           "content": {
             "textAd": {
                 "landingPage": "https://lnkd.in/eabXpqi",
                 "headline": "new prod test headline",
                 "description": "new prod test description"
              }
         }
       }
   }
}

curl --location --request POST 'https://api.linkedin.com/rest/creatives/{sponsoredCreativeUrn}' \
-H 'X-RestLi-Method: partial_update' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'Content-Type: application/json' \
--data '{
"patch": {
       "$set": {
           "content": {
             "textAd": {
                 "landingPage": "https://lnkd.in/eabXpqi",
                 "headline": "new prod test headline",
                 "description": "new prod test description",
                 "image": "urn:li:image:abc"
              }
         }
       }
   }
}'

A successful response returns a 204 No Content. Replace the sponsoredCreativeUrn parameter with an URL encoded valid urn which will look like urn%3Ali%3AsponsoredCreative%3A123456

Delete a Text Ad

http
curl

DELETE https://api.linkedin.com/rest/creatives/{sponsoredCreativeUrn}

curl --location --request DELETE 'https://api.linkedin.com/rest/creatives/{sponsoredCreativeUrn}' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'X-RestLi-Method: DELETE' \
-H 'Authorization: Bearer {INSERT_TOKEN}'

A successful response returns a 204 No Content. Replace the sponsoredCreativeUrn parameter with an URL encoded valid urn which will look like urn%3Ali%3AsponsoredCreative%3A123456

Batch Create Text Ads

http
curl

POST https://api.linkedin.com/rest/creatives

{
  "elements": [
   {
       "content": {
         "textAd": {
           "landingPage": "https://lnkd.in/eabXpqi",
           "headline": "HL1",
           "description": "DP1",
           "image": "urn:li:image:C4E22AQGX_uq7mQBfAA"
         }
       },
       "campaign": "urn:li:sponsoredCampaign:192479594",
       "intendedStatus": "DRAFT"
   },
   {
       "content": {
         "textAd": {
           "landingPage": "https://lnkd.in/eabXpqi",
           "headline": "HL2",
           "description": "DP2",
           "image": "urn:li:image:C4E22AQGX_uq7mQBfAA"
         }
       },
       "campaign": "urn:li:sponsoredCampaign:192479594",
       "intendedStatus": "DRAFT"
   }
 ]
}

curl --location --request POST 'https://api.linkedin.com/rest/creatives' \
-H'X-RestLi-Protocol-Version: 2.0.0' \
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'X-RestLi-Method:BATCH_CREATE' \
-H 'Content-Type: application/json' \
--data '{
  "elements": [
   {
       "content": {
         "textAd": {
           "landingPage": "https://lnkd.in/eabXpqi",
           "headline": "HL1",
           "description": "DP1",
           "image": "urn:li:image:C4E22AQGX_uq7mQBfAA"
         }
       },
       "campaign": "urn:li:sponsoredCampaign:192479594",
       "intendedStatus": "DRAFT"
   },
   {
       "content": {
         "textAd": {
           "landingPage": "https://lnkd.in/eabXpqi",
           "headline": "HL2",
           "description": "DP2",
           "image": "urn:li:image:C4E22AQGX_uq7mQBfAA"
         }
       },
       "campaign": "urn:li:sponsoredCampaign:192479594",
       "intendedStatus": "DRAFT"
   }
 ]
}'

Sample Response

{
   "elements": [
       {
           "location": "/partnerApiCreatives/urn%3Ali%3AsponsoredCreative%3A170811974",
           "status": 201,
           "id": "urn:li:sponsoredCreative:170811974"
       },
       {
           "location": "/partnerApiCreatives/urn%3Ali%3AsponsoredCreative%3A170811984",
           "status": 201,
           "id": "urn:li:sponsoredCreative:170811984"
       }
   ]
}

Batch Get Text Ads

http
curl

GET https://api.linkedin.com/rest/creatives?ids=List({sponsoredCreativeUrn1},{sponsoredCreativeUrn2})

curl --location --request GET 'https://api.linkedin.com/rest/creatives?ids=List({sponsoredCreativeUrn1},{sponsoredCreativeUrn2})' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'X-RestLi-Method: BATCH_GET' \
-H 'Authorization: Bearer {INSERT_TOKEN}'

Sample Response

{
   "results": {
       "urn:li:sponsoredCreative:170811974": {
           "servingHoldReasons": [
               "UNDER_REVIEW",
               "ACCOUNT_SERVING_HOLD"
           ],
           "lastModifiedAt": 1650830101000,
           "lastModifiedBy": "urn:li:system:0",
           "content": {
               "textAd": {
                   "image": "urn:li:image:C4E22AQGX_uq7mQBfAA",
                   "description": "DP1",
                   "headline": "HL1",
                   "landingPage": "https://lnkd.in/eabXpqi"
               }
           },
           "createdAt": 1650830099000,
           "isTest": false,
           "createdBy": "urn:li:person:B1U4S2MZ-C",
           "review": {
               "status": "NEEDS_REVIEW"
           },
           "isServing": false,
           "campaign": "urn:li:sponsoredCampaign:191989474",
           "id": "urn:li:sponsoredCreative:170811974",
           "intendedStatus": "ACTIVE",
           "account": "urn:li:sponsoredAccount:508915158"
       },
       "urn:li:sponsoredCreative:170811984": {
           "servingHoldReasons": [
               "UNDER_REVIEW",
               "ACCOUNT_SERVING_HOLD"
           ],
           "lastModifiedAt": 1650830101000,
           "lastModifiedBy": "urn:li:system:0",
           "content": {
               "textAd": {
                   "image": "urn:li:image:C4E22AQGX_uq7mQBfAA",
                   "description": "DP2",
                   "headline": "HL2",
                   "landingPage": "https://lnkd.in/eabXpqi"
               }
           },
           "createdAt": 1650830099000,
           "isTest": false,
           "createdBy": "urn:li:person:B1U4S2MZ-C",
           "review": {
               "status": "NEEDS_REVIEW"
           },
           "isServing": false,
           "campaign": "urn:li:sponsoredCampaign:191989474",
           "id": "urn:li:sponsoredCreative:170811984",
           "intendedStatus": "ACTIVE",
           "account": "urn:li:sponsoredAccount:508915158"
       }
   },
   "statuses": {
       "urn:li:sponsoredCreative:170811974": 200,
       "urn:li:sponsoredCreative:170811984": 200
   },
   "errors": {}
}

Batch Update Text Ads

http
curl

POST https://api.linkedin.com/rest/creatives?ids=List({sponsoredCreativeUrn1},{sponsoredCreativeUrn2})

{
    "entities": {
        "sponsoredCreativeUrn1": {
            "patch": {
                "$set": {
                    "content": {
                        "textAd": {
                            "headline": "Updated RGW headline_1",
                            "landingPage": "https://lnkd.in/eabXpqi",
                            "description": "Updated RGW test description_1"
                        }
                    }
                }
            }
        },
        "sponsoredCreativeUrn2": {
            "patch": {
                "$set": {
                    "content": {
                        "textAd": {
                            "headline": "Updated RGW headline_2",
                            "landingPage": "https://lnkd.in/eabXpqi",
                            "description": "Updated RGW test description_2"
                        }
                    }
                }
            }
        }
    }
}

curl --location --request POST 'https://api.linkedin.com/rest/creatives?ids=List({sponsoredCreativeUrn1},{sponsoredCreativeUrn2})' \
-H 'X-RestLi-Method: BATCH_PARTIAL_UPDATE' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'Authorization: Bearer {INSERT_TOKEN}' \
-H 'Content-Type: application/json' \
--data '{
    "entities": {
        "sponsoredCreativeUrn1": {
            "patch": {
                "$set": {
                    "content": {
                        "textAd": {
                            "headline": "Updated RGW headline_1",
                            "landingPage": "https://lnkd.in/eabXpqi",
                            "description": "Updated RGW test description_1"
                        }
                    }
                }
            }
        },
        "sponsoredCreativeUrn2": {
            "patch": {
                "$set": {
                    "content": {
                        "textAd": {
                            "headline": "Updated RGW headline_2",
                            "landingPage": "https://lnkd.in/eabXpqi",
                            "description": "Updated RGW test description_2"
                        }
                    }
                }
            }
        }
    }
}'

Sample Response

{
   "results": {
       "urn:li:sponsoredCreative:170811974": {
           "status": 204
       },
       "urn:li:sponsoredCreative:170811984": {
           "status": 204
       }
   },
   "errors": {}
}

Batch Delete Text Ads

http
curl

DELETE https://api.linkedin.com/rest/creatives?ids=List({sponsoredCreativeUrn1},{sponsoredCreativeUrn2})

curl --location --request DELETE 'https://api.linkedin.com/rest/creatives?ids=List({sponsoredCreativeUrn1},{sponsoredCreativeUrn2})' \
-H 'X-RestLi-Protocol-Version: 2.0.0' \
-H 'LinkedIn-Version: {version number in the format YYYYMM}' \
-H 'X-RestLi-Method: BATCH_DELETE' \
-H 'Authorization: Bearer {INSERT_TOKEN}'

Sample Response

{
    "results": {
        "urn:li:sponsoredCreative:170811974": {
            "status": 204
        },
        "urn:li:sponsoredCreative:170811984": {
            "status": 204
        }
    },
    "errors": {}
}

Error Messages

General creative errors are included here - Creatives error.

Share via

Text Ads API

Requirements

Permissions

Schema

Create a Text Ad

Get a Text Ad

Sample Response

Update a Text Ad

Delete a Text Ad

Batch Create Text Ads

Sample Response

Batch Get Text Ads

Sample Response

Batch Update Text Ads

Sample Response

Batch Delete Text Ads

Sample Response

Error Messages

Feedback

Additional resources