LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Marketing Campaign Management Account Management API

5 actions 5 updates phrasing extends openapi/linkedin-account-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 5

$.info
$.paths['/adAccounts'].get
$.paths['/adAccounts'].post
$.paths['/adAccounts/{SponsoredAccountId}'].get
$.paths['/adAccounts/{SponsoredAccountId}'].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 Account Management API
  version: 1.0.0
extends: openapi/linkedin-account-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: 4
- target: $.paths['/adAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search ad accounts by type or status
      effect: read
      questions:
      - Can I find ad accounts by name, reference or type?
      - Which of my ad accounts are currently active?
      instructions:
      - text: Search ad accounts matching {search}.
        slots:
          search: query.search
      - text: Find business ad accounts using criteria {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test or live ad account
      effect: write
      questions:
      - Can I create a test ad account for development?
      - Which currency and company reference does a new ad account need?
      instructions:
      - text: Create an ad account named {name} in {currency} for company {reference}.
        slots:
          name: requestBody.name
          currency: requestBody.currency
          reference: requestBody.reference
      - text: Create a {type} test ad account called {name} with test set to {test}.
        slots:
          type: requestBody.type
          name: requestBody.name
          test: requestBody.test
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{SponsoredAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch an ad account by sponsored account ID
      effect: read
      questions:
      - What currency and status does one ad account have?
      - Can I look up an ad account by its sponsored account ID?
      instructions:
      - text: Fetch ad account {SponsoredAccountId}.
        slots:
          SponsoredAccountId: path.SponsoredAccountId
      - text: Show everything about sponsored account {SponsoredAccountId}.
        slots:
          SponsoredAccountId: path.SponsoredAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{SponsoredAccountId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or patch an ad account
      effect: write
      questions:
      - Can I rename an existing ad account?
      - Is a partial update allowed on an ad account's fields?
      instructions:
      - text: Rename ad account {SponsoredAccountId} with patch {patch}.
        slots:
          SponsoredAccountId: path.SponsoredAccountId
          patch: requestBody.patch
      - text: Update the name of account {SponsoredAccountId}.
        slots:
          SponsoredAccountId: path.SponsoredAccountId
      method: generated
      generated: '2026-09-26'