Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Saved Views API

5 actions 5 updates phrasing extends openapi/live-direct-marketing-online-saved-views-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 5

$.info

$.paths['/api/saved-views'].get

$.paths['/api/saved-views'].post

$.paths['/api/saved-views/{id}'].delete

$.paths['/api/saved-views/{id}'].patch

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 Live Direct Marketing Online Saved Views API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-saved-views-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: 4
- target: $.paths['/api/saved-views'].get
  update:
    x-apievangelist-phrasing:
      intent: List my saved views for a table
      effect: read
      questions:
      - Which saved views do I have for contacts or other tables?
      - Can I see my saved filters for one entity type?
      instructions:
      - text: List my saved views for {entity}.
        slots:
          entity: query.entity
      - text: Show the saved filter views I made on {entity}.
        slots:
          entity: query.entity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/saved-views'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new view
      effect: write
      questions:
      - How do I save my current filters and columns as a view?
      - Can I name a saved view for a table?
      instructions:
      - text: Save a view named {name} for {entity} with config {config}.
        slots:
          name: requestBody.name
          entity: requestBody.entity
          config: requestBody.config
      - text: Create saved view {name} on {entity} using {config}.
        slots:
          name: requestBody.name
          entity: requestBody.entity
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/saved-views/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved view
      effect: destructive
      questions:
      - Can I delete a saved view I created?
      - Who is allowed to remove a saved view?
      instructions:
      - text: Delete saved view {id}.
        slots:
          id: path.id
      - text: Remove my saved view {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/saved-views/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a saved view
      effect: write
      questions:
      - Can I rename a saved view or make it my default?
      - How do I change the filters stored in an existing view?
      instructions:
      - text: Rename saved view {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: 'Make saved view {id} my default: {isDefault}.'
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      - text: Change the config of saved view {id} to {config}.
        slots:
          id: path.id
          config: requestBody.config
      method: generated
      generated: '2026-10-01'