LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Content Use Cases > Spotlight Ad API

5 actions 5 updates phrasing extends openapi/linkedin-use-cases-spotlight-ad-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for LinkedIn's API. It is a proposal applied on top of the contract, not a document LinkedIn publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/creatives'].post

$.paths['/creatives/{sponsoredCreative-urn}'].get

$.paths['/creatives/{sponsoredCreative-urn}'].post

$.paths['/creatives/{sponsoredCreative-urn}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Content Use Cases > Spotlight Ad API
  version: 1.0.0
extends: openapi/linkedin-use-cases-spotlight-ad-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/creatives'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dynamic spotlight ad
      effect: write
      questions:
      - Can I create a spotlight ad that personalizes with the viewer's photo?
      - Where is the ID of a newly created spotlight creative returned?
      instructions:
      - text: Create a dynamic spotlight ad creative using API version {version}.
        slots:
          version: header.LinkedIn-Version
      - text: Set up a new spotlight ad for my campaign.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/creatives/{sponsoredCreative-urn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dynamic spotlight ad
      effect: read
      questions:
      - Why is my spotlight ad on serving hold?
      - Can I retrieve a single spotlight ad creative?
      instructions:
      - text: Get spotlight ad {creative}.
        slots:
          creative: path.sponsoredCreative-urn
      - text: Show the serving hold reasons for spotlight creative {creative}.
        slots:
          creative: path.sponsoredCreative-urn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/creatives/{sponsoredCreative-urn}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a dynamic spotlight ad
      effect: write
      questions:
      - Can I change the status of a spotlight ad?
      - Is it possible to edit a spotlight ad creative after launch?
      instructions:
      - text: Update spotlight ad {creative}.
        slots:
          creative: path.sponsoredCreative-urn
      - text: Pause dynamic spotlight creative {creative}.
        slots:
          creative: path.sponsoredCreative-urn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/creatives/{sponsoredCreative-urn}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dynamic spotlight ad
      effect: destructive
      questions:
      - Can I delete a spotlight ad creative?
      - What happens when I remove a dynamic spotlight ad?
      instructions:
      - text: Delete spotlight ad {creative}.
        slots:
          creative: path.sponsoredCreative-urn
      - text: Remove dynamic spotlight creative {creative} permanently.
        slots:
          creative: path.sponsoredCreative-urn
      method: generated
      generated: '2026-09-26'