Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Campaign Groups API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-campaign-groups-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/campaign-groups'].get
$.paths['/api/campaign-groups'].post
$.paths['/api/campaign-groups/reorder'].post
$.paths['/api/campaign-groups/{id}'].delete
$.paths['/api/campaign-groups/{id}'].patch

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 Live Direct Marketing Online Campaign Groups API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-campaign-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/campaign-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaign groups
      effect: read
      questions:
      - What campaign groups (folders) do I have?
      - How are my campaign groups nested under parents?
      instructions:
      - text: List all campaign groups with their parents.
      - text: Show my campaign folder tree.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/campaign-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign group
      effect: write
      questions:
      - How do I create a folder to organize campaigns?
      - Can I nest a new campaign group under an existing one?
      instructions:
      - text: Create a campaign group called Q4 Outreach.
      - text: Add a new campaign group under the Partners group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/campaign-groups/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder campaign groups
      effect: write
      questions:
      - How do I change the order my campaign groups appear in?
      - Can I set the sort order of several campaign groups at once?
      instructions:
      - text: Reorder my campaign groups to this sequence.
      - text: Move the Partners campaign group to the top of the list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/campaign-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a campaign group
      effect: destructive
      questions:
      - What happens to campaigns inside a group when I delete it?
      - How do I remove a campaign group?
      instructions:
      - text: Delete campaign group {id}.
        slots:
          id: path.id
      - text: Remove group {id} and detach its campaigns.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/campaign-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a campaign group
      effect: write
      questions:
      - How do I rename or recolor a campaign group?
      - Can I move a campaign group under a different parent?
      instructions:
      - text: Rename campaign group {id} to Enterprise.
        slots:
          id: path.id
      - text: Change the color of campaign group {id} to green.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'