LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Content Use Cases > Creatives API

5 actions 5 updates phrasing extends openapi/linkedin-use-cases-creatives-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'].get
$.paths['/creatives/{urn_creatives}'].get
$.paths['/creatives/{creative ID}'].post
$.paths['/creatives/{creative ID}'].delete

OpenAPI Overlay

Raw ↑
# 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 > Creatives API
  version: 1.0.0
extends: openapi/linkedin-use-cases-creatives-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'].get
  update:
    x-apievangelist-phrasing:
      intent: Search ad creatives by campaign or account
      effect: read
      questions:
      - Which creatives are running in a given campaign?
      - Can I search creatives by intended status or content reference?
      - Is there a way to include the total count when searching creatives?
      instructions:
      - text: Search creatives in campaigns {campaigns}.
        slots:
          campaigns: query.campaigns
      - text: Find creatives for accounts {accounts} with status {intendedStatuses}.
        slots:
          accounts: query.accounts
          intendedStatuses: query.intendedStatuses
      - text: Search creatives using post {contentReferences} sorted {sortOrder}.
        slots:
          contentReferences: query.contentReferences
          sortOrder: query.sortOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/creatives/{urn_creatives}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sponsored creative
      effect: read
      questions:
      - What status and content does one creative have?
      - Can I fetch a single sponsored creative by URN?
      instructions:
      - text: Get creative {urn_creatives}.
        slots:
          urn_creatives: path.urn_creatives
      - text: Show the review status of creative {urn_creatives}.
        slots:
          urn_creatives: path.urn_creatives
      method: generated
      generated: '2026-09-26'
- target: $.paths['/creatives/{creative ID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a creative's status or call to action
      effect: write
      questions:
      - Can I pause a creative by changing its intended status?
      - When can I still change the lead form behind a creative's call to action?
      instructions:
      - text: Set the intended status of my creative to paused.
      - text: Change the lead gen call-to-action label on my draft creative.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/creatives/{creative ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a creative
      effect: destructive
      questions:
      - Can I delete a creative that has never served?
      - What should I do to remove a creative that can't be deleted outright?
      instructions:
      - text: Delete my unused draft creative.
      - text: Permanently remove the creative that meets deletion conditions.
      method: generated
      generated: '2026-09-26'