LinkedIn · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/adAccounts/{AdAccountsId}/adCampaignGroups'].get
$.paths['/adAccounts/{AdAccountsId}/adCampaignGroups'].delete
$.paths['/adAccounts/{AdAccountsId}/adCampaignGroups/{CampaignGroupId}'].get
$.paths['/adAccounts/{AdAccountsId}/adCampaignGroups/{CampaignGroupId}'].post
$.paths['/adAccounts/{AdAccountsId}/adCampaignGroups/{CampaignGroupId}'].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 LinkedIn Marketing Campaign Management Campaign Group Management API
  version: 1.0.0
extends: openapi/linkedin-campaign-group-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: 5
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaignGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: Search campaign groups in an ad account
      effect: read
      questions:
      - Which campaign groups exist in my ad account?
      - Can I search campaign groups by name or status and sort the results?
      instructions:
      - text: Search campaign groups in ad account {AdAccountsId} matching {search}.
        slots:
          AdAccountsId: path.AdAccountsId
          search: query.search
      - text: List campaign groups for {AdAccountsId} sorted by {sort}.
        slots:
          AdAccountsId: path.AdAccountsId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaignGroups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several draft campaign groups
      effect: destructive
      questions:
      - Can I delete multiple draft campaign groups in one call?
      - Which campaign groups are eligible for bulk deletion?
      instructions:
      - text: Delete campaign groups {ids} from ad account {AdAccountsId}.
        slots:
          ids: query.ids
          AdAccountsId: path.AdAccountsId
      - text: Bulk remove the draft campaign groups {ids} in {AdAccountsId}.
        slots:
          ids: query.ids
          AdAccountsId: path.AdAccountsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaignGroups/{CampaignGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a campaign group by ID
      effect: read
      questions:
      - What budget and schedule does one campaign group have?
      - Can I retrieve a single campaign group by its ID?
      instructions:
      - text: Fetch campaign group {CampaignGroupId} in account {AdAccountsId}.
        slots:
          CampaignGroupId: path.CampaignGroupId
          AdAccountsId: path.AdAccountsId
      - text: Show details for campaign group {CampaignGroupId} of {AdAccountsId}.
        slots:
          CampaignGroupId: path.CampaignGroupId
          AdAccountsId: path.AdAccountsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaignGroups/{CampaignGroupId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Partially update a campaign group
      effect: write
      questions:
      - Can I change a campaign group's name or status without resending everything?
      - Is a partial update supported for campaign groups?
      instructions:
      - text: Update campaign group {CampaignGroupId} in account {AdAccountsId}.
        slots:
          CampaignGroupId: path.CampaignGroupId
          AdAccountsId: path.AdAccountsId
      - text: Pause campaign group {CampaignGroupId} under {AdAccountsId}.
        slots:
          CampaignGroupId: path.CampaignGroupId
          AdAccountsId: path.AdAccountsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{AdAccountsId}/adCampaignGroups/{CampaignGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single draft campaign group
      effect: destructive
      questions:
      - Can I delete one campaign group that was never launched?
      - Why would deleting an active campaign group fail?
      instructions:
      - text: Delete draft campaign group {CampaignGroupId} from {AdAccountsId}.
        slots:
          CampaignGroupId: path.CampaignGroupId
          AdAccountsId: path.AdAccountsId
      - text: Remove the one draft group {CampaignGroupId} in ad account {AdAccountsId}.
        slots:
          CampaignGroupId: path.CampaignGroupId
          AdAccountsId: path.AdAccountsId
      method: generated
      generated: '2026-09-26'