API Evangelist conversational phrasing for Outbrain Promoted Links API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Outbrain Promoted Links API
  version: 1.0.0
extends: openapi/outbrain-promotedlinks-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: 10
- target: $.paths['/promotedLinks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a promoted link with image sizing
      effect: read
      questions:
      - How do I see the headline, image and approval status of one ad?
      - Can I get a promoted link's image back at a specific width and height?
      instructions:
      - text: Show promoted link {id}.
        slots:
          id: path.id
      - text: Get promoted link {id} with its image sized {width} by {height}.
        slots:
          id: path.id
          width: query.promotedLinkImageWidth
          height: query.promotedLinkImageHeight
      method: generated
      generated: '2026-09-26'
- target: $.paths['/promotedLinks/{ids}'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or pause promoted links by ID
      effect: write
      questions:
      - How do I pause several ads at once using their IDs?
      - Can I switch promoted links back on without touching their CPC?
      instructions:
      - text: Pause promoted links {ids}.
        slots:
          ids: path.ids
      - text: Turn promoted links {ids} back on.
        slots:
          ids: path.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/promotedLinks'].get
  update:
    x-apievangelist-phrasing:
      intent: List all ad creatives in a campaign
      effect: read
      questions:
      - What ad creatives are running in my campaign?
      - Where can I get every promoted link for a campaign without filters?
      instructions:
      - text: List all ad creatives in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Give me every promoted link belonging to campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/promotedLinks'].put
  update:
    x-apievangelist-phrasing:
      intent: Set CPC or status on a campaign's promoted links
      effect: write
      questions:
      - Can I set a different CPC on individual ads within a campaign?
      - How do I change the bid on promoted links in one campaign?
      instructions:
      - text: Set the CPC of the top ads in campaign {campaignId} to 0.45.
        slots:
          campaignId: path.campaignId
      - text: Update the promoted link bid values in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/promotedLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create one promoted link in a campaign
      effect: write
      questions:
      - How do I add a single new ad with my own headline and image to a campaign?
      - What happens if I don't supply an image or headline for a new ad?
      instructions:
      - text: Add a promoted link for my new blog post to campaign {campaignId} with a custom headline.
        slots:
          campaignId: path.campaignId
      - text: Create one ad in campaign {campaignId} using my hosted image and section name.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/multiplePromotedLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several promoted links in one request
      effect: write
      questions:
      - Can I upload a batch of new ads to a campaign in one call?
      - Is there a bulk way to create many promoted links with their images?
      instructions:
      - text: Create these five new ads in campaign {campaignId} in one batch.
        slots:
          campaignId: path.campaignId
      - text: Bulk-add promoted links for my article list to campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/promotedLinks/'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-edit up to 500 promoted links
      effect: write
      questions:
      - Can I change titles and descriptions on hundreds of ads at once?
      - Which ad fields can be edited only while approval status is still editable?
      instructions:
      - text: Bulk-edit titles, descriptions and logos on the ads in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Update section names and images for up to 500 promoted links in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/promotedLinks'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter and page a campaign's promoted links
      effect: read
      questions:
      - How do I list only the enabled ads in a campaign?
      - Can I filter a campaign's promoted links by approval status and sort them?
      instructions:
      - text: List enabled promoted links in campaign {id} with status {statuses}.
        slots:
          id: path.id
          statuses: query.statuses
      - text: Page through campaign {id} ads {limit} at a time sorted by {sort}.
        slots:
          id: path.id
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/promotedLinks/{promotedLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a promoted link by its identifier
      effect: read
      questions:
      - How do I fetch an ad when all I have is its promotedLinkId?
      - What basic record does a promoted link lookup by identifier return?
      instructions:
      - text: Look up promoted link {promotedLinkId}.
        slots:
          promotedLinkId: path.promotedLinkId
      - text: Fetch the ad record with identifier {promotedLinkId}.
        slots:
          promotedLinkId: path.promotedLinkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/promotedLinks/{promotedLinkId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a promoted link's text, URL or image
      effect: write
      questions:
      - How do I change the landing page URL on one of my ads?
      - Can I replace an ad's headline text and image URL?
      instructions:
      - text: Change promoted link {promotedLinkId} to text {text} and URL {url}.
        slots:
          promotedLinkId: path.promotedLinkId
          text: requestBody.text
          url: requestBody.url
      - text: Update promoted link {promotedLinkId} with headline {text}, link {url} and image {imageUrl}.
        slots:
          promotedLinkId: path.promotedLinkId
          text: requestBody.text
          url: requestBody.url
          imageUrl: requestBody.imageUrl
      method: generated
      generated: '2026-09-26'