LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Marketing Campaign Management API

4 actions 4 updates phrasing extends openapi/linkedin-campaign-management-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 4

$.info
$.paths['/adAccounts/{AdAccountsId}/adCampaigns'].get
$.paths['/adAccounts/{AdAccountsId}/adCampaigns/{CampaignId}'].get
$.paths['/adAccounts/{AdAccountsId}/adCampaigns/{CampaignId}'].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 LinkedIn Marketing Campaign Management API
  version: 1.0.0
extends: openapi/linkedin-campaign-management-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: 3
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: Search campaigns, optionally by campaign group
      effect: read
      questions:
      - Which campaigns belong to a specific campaign group?
      - Can I search the campaigns in an ad account?
      instructions:
      - text: Search campaigns in ad account {AdAccountsId}.
        slots:
          AdAccountsId: path.AdAccountsId
      - text: List campaigns in {AdAccountsId} within campaign group {group}.
        slots:
          AdAccountsId: path.AdAccountsId
          group: query.search.campaignGroup.values[0]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaigns/{CampaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a campaign by ID
      effect: read
      questions:
      - What are the settings of one campaign in my account?
      - Can I look up a campaign by its ID?
      instructions:
      - text: Fetch campaign {CampaignId} in account {AdAccountsId}.
        slots:
          CampaignId: path.CampaignId
          AdAccountsId: path.AdAccountsId
      - text: Show campaign {CampaignId} details from {AdAccountsId}.
        slots:
          CampaignId: path.CampaignId
          AdAccountsId: path.AdAccountsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaigns/{CampaignId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a campaign
      effect: write
      questions:
      - Can I archive a campaign I no longer run?
      - What status change retires an old campaign?
      instructions:
      - text: Archive campaign {CampaignId} in account {AdAccountsId}.
        slots:
          CampaignId: path.CampaignId
          AdAccountsId: path.AdAccountsId
      - text: Set campaign {CampaignId} in {AdAccountsId} to archived with patch {patch}.
        slots:
          CampaignId: path.CampaignId
          AdAccountsId: path.AdAccountsId
          patch: requestBody.patch
      method: generated
      generated: '2026-09-26'