Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Share Links API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-share-links-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 4

$.info
$.paths['/api/share-links'].get
$.paths['/api/share-links'].post
$.paths['/api/share-links/{id}'].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 Live Direct Marketing Online Share Links API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-share-links-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: 3
- target: $.paths['/api/share-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List share links for a record
      effect: read
      questions:
      - Which share links exist for a particular record?
      - Can I see who I've shared a report or list with via links?
      instructions:
      - text: List share links for {entityType} {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      - text: Show the active share links on {entityType} record {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/share-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a share link for a record
      effect: write
      questions:
      - How do I create a link to share a record with someone outside?
      - Can I generate a shareable URL for an item?
      instructions:
      - text: Create a share link for this record.
      - text: Generate a new shareable URL for an item.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/share-links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a share link
      effect: destructive
      questions:
      - Can I stop a share link from working?
      - How do I revoke access I gave through a link?
      instructions:
      - text: Revoke share link {id}.
        slots:
          id: path.id
      - text: Disable share link {id} so it no longer opens.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'