Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Tags API

11 actions 11 updates phrasing extends openapi/live-direct-marketing-online-tags-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 11

$.info
$.paths['/api/tags'].get
$.paths['/api/tags'].post
$.paths['/api/tags/{id}'].delete
$.paths['/api/tags/{id}'].patch
$.paths['/api/tags/companies/{companyId}'].post
$.paths['/api/tags/companies/{companyId}/{tagId}'].delete
$.paths['/api/tags/contacts/{contactId}'].post
$.paths['/api/tags/contacts/{contactId}/{tagId}'].delete
$.paths['/api/tags/leads/{leadId}'].post
$.paths['/api/tags/leads/{leadId}/{tagId}'].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 Tags API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-tags-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: 10
- target: $.paths['/api/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspace tags
      effect: read
      questions:
      - What tags exist in my workspace?
      - Can I see every tag I can apply to companies, contacts and leads?
      instructions:
      - text: List all tags in my workspace.
      - text: Show my available tags.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I make a new tag for organizing records?
      - Can I give a new tag a color?
      instructions:
      - text: Create a tag named {name}.
        slots:
          name: requestBody.name
      - text: Add a new {color} tag called {name}.
        slots:
          color: requestBody.color
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - Can I delete a tag from the workspace entirely?
      - How do I get rid of a tag nobody uses?
      instructions:
      - text: Delete tag {id}.
        slots:
          id: path.id
      - text: Remove tag {id} from the workspace.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or recolor a tag
      effect: write
      questions:
      - Can I rename a tag I already created?
      - What's the way to change an existing tag's color?
      instructions:
      - text: Rename tag {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the color of tag {id} to {color}.
        slots:
          id: path.id
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/companies/{companyId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a company
      effect: write
      questions:
      - How do I apply a tag to a company?
      - Can I label a company record with an existing tag?
      instructions:
      - text: Attach tag {tagId} to company {companyId}.
        slots:
          tagId: requestBody.tagId
          companyId: path.companyId
      - text: Label company {companyId} with tag {tagId}.
        slots:
          companyId: path.companyId
          tagId: requestBody.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/companies/{companyId}/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from a company
      effect: destructive
      questions:
      - Can I take a tag off a company without deleting the tag?
      - What removes one label from a company record?
      instructions:
      - text: Detach tag {tagId} from company {companyId}.
        slots:
          tagId: path.tagId
          companyId: path.companyId
      - text: Untag company {companyId} by removing {tagId}.
        slots:
          companyId: path.companyId
          tagId: path.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/contacts/{contactId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a contact
      effect: write
      questions:
      - Can I add a tag to an individual contact?
      - Is there a way to label a contact with a tag?
      instructions:
      - text: Attach tag {tagId} to contact {contactId}.
        slots:
          tagId: requestBody.tagId
          contactId: path.contactId
      - text: Label contact {contactId} with tag {tagId}.
        slots:
          contactId: path.contactId
          tagId: requestBody.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/contacts/{contactId}/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from a contact
      effect: destructive
      questions:
      - How do I remove a tag from one contact?
      - Can I untag a contact but keep the tag for others?
      instructions:
      - text: Detach tag {tagId} from contact {contactId}.
        slots:
          tagId: path.tagId
          contactId: path.contactId
      - text: Untag contact {contactId} by removing {tagId}.
        slots:
          contactId: path.contactId
          tagId: path.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/leads/{leadId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a lead
      effect: write
      questions:
      - Can I put a tag on a lead in my pipeline?
      - Which call labels a lead with a tag?
      instructions:
      - text: Attach tag {tagId} to lead {leadId}.
        slots:
          tagId: requestBody.tagId
          leadId: path.leadId
      - text: Label lead {leadId} with tag {tagId}.
        slots:
          leadId: path.leadId
          tagId: requestBody.tagId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tags/leads/{leadId}/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from a lead
      effect: destructive
      questions:
      - How can I take a tag off a lead?
      - Can I untag a single lead without touching other leads?
      instructions:
      - text: Detach tag {tagId} from lead {leadId}.
        slots:
          tagId: path.tagId
          leadId: path.leadId
      - text: Untag lead {leadId} by removing {tagId}.
        slots:
          leadId: path.leadId
          tagId: path.tagId
      method: generated
      generated: '2026-10-01'