API Evangelist conversational phrasing for Live Direct Marketing Online Companies API

# 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 Companies API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-companies-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: 23
- target: $.paths['/api/companies/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get company statistics
      effect: read
      questions:
      - How many companies do I have in my CRM and how are they broken down?
      - Can I get company stats for just one list?
      instructions:
      - text: Show company statistics for my whole workspace.
      - text: Get company stats scoped to list {listId}.
        slots:
          listId: query.listId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter companies
      effect: read
      questions:
      - Can I page through my companies and search them by name or domain?
      - Which companies are in a particular list, sorted by when they were added?
      - Is it possible to see companies I've moved to the trash?
      instructions:
      - text: List companies matching {search} with includeDeleted={includeDeleted}.
        slots:
          search: query.search
          includeDeleted: query.includeDeleted
      - text: Show companies in list {listId} sorted by {sortBy}.
        slots:
          listId: query.listId
          sortBy: query.sortBy
      - text: List only trashed companies (onlyDeleted={onlyDeleted}).
        slots:
          onlyDeleted: query.onlyDeleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company record
      effect: write
      questions:
      - How do I add a new company to my CRM?
      - Can I set the domain, industry and country when creating a company?
      - Why can't I put an email directly on a new company?
      instructions:
      - text: Create a company named {name} with domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
      - text: Add company {name} in {country}, industry {industry}.
        slots:
          name: requestBody.name
          country: requestBody.country
          industry: requestBody.industry
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/duplicates'].get
  update:
    x-apievangelist-phrasing:
      intent: Find duplicate companies
      effect: read
      questions:
      - Do I have duplicate companies in my workspace?
      - Which companies share the same tax number, domain or name?
      instructions:
      - text: Find duplicate company groups in my workspace.
      - text: Show page {page} of duplicate companies, {pageSize} groups per page.
        slots:
          page: query.page
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company by id
      effect: read
      questions:
      - What details do I have stored for a specific company?
      - Can I pull up one company record by its id?
      instructions:
      - text: Show company {id}.
        slots:
          id: path.id
      - text: Fetch the full record for company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Move a company to the trash
      effect: destructive
      questions:
      - How do I delete a company but keep the option to restore it?
      - Can I send a company to the trash instead of erasing it?
      instructions:
      - text: Soft-delete company {id}.
        slots:
          id: path.id
      - text: Move company {id} to the trash.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a company's details
      effect: write
      questions:
      - Can I change the website, phone or LinkedIn of an existing company?
      - How do I fix the industry on a company I already added?
      instructions:
      - text: Change the domain of company {id} to {domain}.
        slots:
          id: path.id
          domain: requestBody.domain
      - text: Set the LinkedIn URL of existing company {id} to {linkedin}.
        slots:
          id: path.id
          linkedin: requestBody.linkedin
      - text: Rename existing company {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}/timeline'].get
  update:
    x-apievangelist-phrasing:
      intent: View a company's activity timeline
      effect: read
      questions:
      - What has happened with a company recently?
      - Can I see the event history for one company page by page?
      instructions:
      - text: Show the timeline of events for company {id}.
        slots:
          id: path.id
      - text: Get page {page} of company {id}'s timeline.
        slots:
          page: query.page
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a bulk action on companies
      effect: write
      questions:
      - Can I tag or delete many companies at once?
      - Is there a way to add a batch of companies to a list in one go?
      instructions:
      - text: Run bulk action {action} on companies {companyIds}.
        slots:
          action: requestBody.action
          companyIds: requestBody.companyIds
      - text: Add companies {companyIds} to list {listId} in bulk using action {action}.
        slots:
          companyIds: requestBody.companyIds
          listId: requestBody.listId
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/bulk/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk company job
      effect: read
      questions:
      - Has my bulk company action finished yet?
      - What is the progress of a bulk job on companies?
      instructions:
      - text: Check the status of bulk company job {jobId}.
        slots:
          jobId: path.jobId
      - text: Tell me whether company bulk job {jobId} has finished.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/bulk/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a bulk company job
      effect: destructive
      questions:
      - Can I stop a bulk company action that is still running?
      - How do I abort an in-progress bulk job on companies?
      instructions:
      - text: Cancel bulk company job {jobId}.
        slots:
          jobId: path.jobId
      - text: Abort the running company bulk job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/export/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List exportable company columns
      effect: read
      questions:
      - Which columns can I include when exporting companies?
      - What fields are available for a company export?
      instructions:
      - text: List the columns available for a company export.
      - text: Show me which company fields can be exported.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export companies to a file
      effect: read
      questions:
      - Can I download my companies as a spreadsheet?
      - How do I export just the companies from one list?
      instructions:
      - text: Export companies with scope {scope} as {format}.
        slots:
          scope: requestBody.scope
          format: requestBody.format
      - text: Export the companies in list {listId} using scope {scope}.
        slots:
          listId: requestBody.listId
          scope: requestBody.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge companies into one record
      effect: destructive
      questions:
      - Can I combine several duplicate companies into a single record?
      - Which company is kept when I merge duplicates?
      instructions:
      - text: Merge companies {mergeIds} into keeper {keepId}.
        slots:
          mergeIds: requestBody.mergeIds
          keepId: requestBody.keepId
      - text: Keep company {keepId} and fold {mergeIds} into it.
        slots:
          keepId: requestBody.keepId
          mergeIds: requestBody.mergeIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/import/google-sheets'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch company rows from Google Sheets
      effect: read
      questions:
      - Can I import companies straight from a Google Sheet?
      - Does it suggest a column mapping when I load a Google Sheets URL?
      instructions:
      - text: Load company rows from Google Sheet {url}.
        slots:
          url: requestBody.url
      - text: Fetch the headers and rows of {url} for a company import.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/import/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a companies import
      effect: read
      questions:
      - Can I see how my company rows will be mapped before importing them?
      - What will a companies import look like with my proposed mapping?
      instructions:
      - text: Preview importing these {rows} with mapping {mapping}.
        slots:
          rows: requestBody.rows
          mapping: requestBody.mapping
      - text: Dry-run the company import using column mapping {mapping}.
        slots:
          mapping: requestBody.mapping
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/import/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a companies-only import
      effect: write
      questions:
      - How do I actually run an import of companies from my file?
      - Can an import skip, update or enrich companies that already exist?
      instructions:
      - text: Import company {rows} using mapping {mapping}.
        slots:
          rows: requestBody.rows
          mapping: requestBody.mapping
      - text: Start the companies import with mapping {mapping} and options {options}.
        slots:
          mapping: requestBody.mapping
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/import/combined'].post
  update:
    x-apievangelist-phrasing:
      intent: Import companies with their contacts
      effect: write
      questions:
      - Can I import companies and their contacts from the same file?
      - Is there a single import that creates both company and contact records?
      instructions:
      - text: Run a combined companies-and-contacts import of {rows} with mapping {mapping}.
        slots:
          rows: requestBody.rows
          mapping: requestBody.mapping
      - text: Import companies plus contacts using mapping {mapping} and options {options}.
        slots:
          options: requestBody.options
          mapping: requestBody.mapping
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a trashed company
      effect: write
      questions:
      - Can I bring back a company I deleted by mistake?
      - How do I undo a company soft-delete?
      instructions:
      - text: Restore company {id} from the trash.
        slots:
          id: path.id
      - text: Undelete company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}/purge'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a trashed company
      effect: destructive
      questions:
      - Can I erase a company from the trash forever?
      - Is there an irreversible delete for companies already in the trash?
      instructions:
      - text: Permanently purge trashed company {id}.
        slots:
          id: path.id
      - text: Erase company {id} from the trash for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/import/rollback/{batchId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Roll back a company import batch
      effect: destructive
      questions:
      - Can I undo a company import that went wrong?
      - How do I remove every company created by one import batch?
      instructions:
      - text: Roll back company import batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Undo the companies imported in batch {batchId}.
        slots:
          batchId: path.batchId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}/freeze'].patch
  update:
    x-apievangelist-phrasing:
      intent: Freeze a company to block sending
      effect: write
      questions:
      - Can I stop campaigns from emailing a particular company?
      - What does freezing a company do?
      instructions:
      - text: Freeze company {id} so campaigns skip it.
        slots:
          id: path.id
      - text: Block campaign sending to company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/{id}/unfreeze'].patch
  update:
    x-apievangelist-phrasing:
      intent: Unfreeze a company
      effect: write
      questions:
      - How do I let campaigns reach a frozen company again?
      - Does unfreezing a company resend the messages it skipped?
      instructions:
      - text: Unfreeze company {id}.
        slots:
          id: path.id
      - text: Set frozen company {id} back to active.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'