LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Content Use Cases > Conversation Ad > Sponsored Conversations API

5 actions 5 updates phrasing extends openapi/linkedin-use-cases-conversation-ad-sponsored-conversations-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['/conversationAds'].get
$.paths['/conversationAds'].post
$.paths['/conversationAds/{conversationUrn}'].get
$.paths['/conversationAds/{conversationUrn}'].post

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 > Conversation Ad > Sponsored Conversations API
  version: 1.0.0
extends: openapi/linkedin-use-cases-conversation-ad-sponsored-conversations-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['/conversationAds'].get
  update:
    x-apievangelist-phrasing:
      intent: Batch get sponsored conversations
      effect: read
      questions:
      - Can I look up several sponsored conversations at once?
      - Which of my conversation ads were created successfully?
      instructions:
      - text: Get sponsored conversations {ids}.
        slots:
          ids: query.ids
      - text: Batch fetch the conversation ads {ids} and their statuses.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversationAds'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sponsored conversation
      effect: write
      questions:
      - Can I create a new conversation ad shell before adding messages?
      - Where do I find the ID of a conversation ad I just created?
      instructions:
      - text: Create a new sponsored conversation for my ad account.
      - text: Start a conversation ad and return its new ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversationAds/{conversationUrn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sponsored conversation
      effect: read
      questions:
      - Which ad account owns a particular conversation ad?
      - Can I retrieve one sponsored conversation by URN?
      instructions:
      - text: Get sponsored conversation {conversationUrn}.
        slots:
          conversationUrn: path.conversationUrn
      - text: Show the parent account of conversation {conversationUrn}.
        slots:
          conversationUrn: path.conversationUrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversationAds/{conversationUrn}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a sponsored conversation
      effect: write
      questions:
      - Can I change which message opens my conversation ad?
      - Is it possible to edit a sponsored conversation after creation?
      instructions:
      - text: Update sponsored conversation {conversationUrn}.
        slots:
          conversationUrn: path.conversationUrn
      - text: Point the first message of {conversationUrn} to a different message.
        slots:
          conversationUrn: path.conversationUrn
      method: generated
      generated: '2026-09-26'