LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Linkedin Ad Accounts API

7 actions 7 updates phrasing extends openapi/linkedin-ad-accounts-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 7

$.info

$.paths['/adAccounts'].get

$.paths['/rest/adAccounts'].get

$.paths['/rest/adAccounts'].post

$.paths['/rest/adAccounts/{adAccountID}'].get

$.paths['/rest/adAccounts/{adAccountID}'].post

$.paths['/rest/adAccounts/{adAccountID}'].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 Linkedin Ad Accounts API
  version: 1.0.0
extends: openapi/linkedin-ad-accounts-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: 6
- target: $.paths['/adAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve the user's ad accounts with filters
      effect: read
      questions:
      - Which ad accounts does my authenticated user have on LinkedIn?
      - Can I filter my ad accounts by type, status or test flag?
      instructions:
      - text: Retrieve my ad accounts filtered by {search}.
        slots:
          search: query.search
      - text: List my ad accounts returning only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/adAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search ad accounts with page tokens
      effect: read
      questions:
      - Can I page through ad account search results with a page token?
      - What page size can I use when searching ad accounts on the rest endpoint?
      instructions:
      - text: Search ad accounts matching {search}, {pageSize} per page.
        slots:
          search: query.search
          pageSize: query.pageSize
      - text: Get the next page of ad accounts using token {pageToken}.
        slots:
          pageToken: query.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/adAccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create one or more ad accounts
      effect: write
      questions:
      - Can I create several ad accounts in one batch request?
      - What's needed to open a new advertising account?
      instructions:
      - text: Create a new ad account.
      - text: Batch create ad accounts using restli method {method}.
        slots:
          method: header.X-RestLi-Method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/adAccounts/{adAccountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch one ad account by ID
      effect: read
      questions:
      - What are the settings of a specific ad account?
      - Can I look up one ad account by its numeric ID?
      instructions:
      - text: Fetch ad account {adAccountID}.
        slots:
          adAccountID: path.adAccountID
      - text: Show the details of account {adAccountID}.
        slots:
          adAccountID: path.adAccountID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/adAccounts/{adAccountID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Partially update an ad account
      effect: write
      questions:
      - Can I change just one field on an existing ad account?
      - What does a patch payload for an ad account update look like?
      instructions:
      - text: Update ad account {adAccountID} with patch {patch}.
        slots:
          adAccountID: path.adAccountID
          patch: requestBody.patch
      - text: Apply a partial change to account {adAccountID}.
        slots:
          adAccountID: path.adAccountID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/adAccounts/{adAccountID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a draft ad account
      effect: destructive
      questions:
      - Can I delete an ad account that is still in draft?
      - Which ad accounts are eligible for deletion?
      instructions:
      - text: Delete draft ad account {adAccountID}.
        slots:
          adAccountID: path.adAccountID
      - text: Remove the unused draft account {adAccountID}.
        slots:
          adAccountID: path.adAccountID
      method: generated
      generated: '2026-09-26'