Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outbrain Amplify Promoted Links Sequences API

5 actions 5 updates phrasing extends openapi/outbrain-promotedlinkssequences-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Outbrain's API. It is a proposal applied on top of the contract, not a document Outbrain publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/promotedLinksSequences/{id}'].get
$.paths['/campaigns/{campaignId}/promotedLinksSequences'].get
$.paths['/campaigns/{campaignId}/promotedLinksSequences'].post
$.paths['/promotedLinksSequences/{promotedLinksSequenceId}'].put

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 Outbrain Amplify Promoted Links Sequences API
  version: 1.0.0
extends: openapi/outbrain-promotedlinkssequences-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['/promotedLinksSequences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a promoted links sequence
      effect: read
      questions:
      - How do I view one carousel or app install sequence by its ID?
      - What promoted links are inside a given sequence?
      instructions:
      - text: Show promoted links sequence {id}.
        slots:
          id: path.id
      - text: List the cards in carousel sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/promotedLinksSequences'].get
  update:
    x-apievangelist-phrasing:
      intent: List a campaign's promoted links sequences
      effect: read
      questions:
      - Which carousels does my campaign have?
      - Can I list only the sequences that are currently on air?
      instructions:
      - text: List promoted links sequences for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Show only on-air sequences in campaign {campaignId}, {limit} at a time.
        slots:
          campaignId: path.campaignId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/promotedLinksSequences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a carousel or promoted links sequence
      effect: write
      questions:
      - How do I create a carousel ad with several promoted links?
      - What's mandatory when creating a sequence, like logo and sponsor?
      instructions:
      - text: Create a carousel sequence in campaign {campaignId} with my logo, sponsor name and four links.
        slots:
          campaignId: path.campaignId
      - text: Add an app install sequence with ratings enabled to campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/promotedLinksSequences/{promotedLinksSequenceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a promoted links sequence
      effect: write
      questions:
      - Can I change the title or sponsor on an existing carousel?
      - How do I pause a promoted links sequence?
      instructions:
      - text: Disable sequence {sequence}.
        slots:
          sequence: path.promotedLinksSequenceId
      - text: Change the carousel title and logo on sequence {sequence}.
        slots:
          sequence: path.promotedLinksSequenceId
      method: generated
      generated: '2026-09-26'