# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lemlist Companies API
  version: 1.0.0
extends: openapi/lemlist-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: 5
- target: $.paths['/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search my companies
      effect: read
      questions:
      - Which companies are stored in my lemlist account?
      - Can I search my companies by name, ignoring case?
      - How do I return only certain fields for each company?
      instructions:
      - text: List my companies.
      - text: Search my companies for {search}.
        slots:
          search: query.search
      - text: Get page {page} of companies with only the fields {fields}.
        slots:
          page: query.page
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a company
      effect: write
      questions:
      - How do I add a company, or update it if its domain already exists?
      - Can I assign an owner to a company by teammate email?
      - What happens to empty fields when I upsert a company?
      instructions:
      - text: Add company {name} with domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
      - text: Upsert the company at {linkedinUrl} and set its industry to {industry}.
        slots:
          linkedinUrl: requestBody.linkedinUrl
          industry: requestBody.industry
      - text: Assign company {companyId} to owner {companyOwner}.
        slots:
          companyId: requestBody.companyId
          companyOwner: requestBody.companyOwner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's notes
      effect: read
      questions:
      - Where can I read the notes my team left on a company?
      - Can I page through the notes on one account, oldest first?
      instructions:
      - text: Show the notes on company {companyId}.
        slots:
          companyId: path.companyId
      - text: Get page {page} of notes for company {companyId}.
        slots:
          page: query.page
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a company
      effect: write
      questions:
      - How do I attach a note to a company record?
      - Can I log context about an account for my teammates?
      instructions:
      - text: Add the note {note} to company {companyId}.
        slots:
          note: requestBody.note
          companyId: path.companyId
      - text: Write a note on company {companyId} saying {note}.
        slots:
          companyId: path.companyId
          note: requestBody.note
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/{companyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company
      effect: destructive
      questions:
      - Can I delete a company that still has contacts attached to it?
      - Does deleting a company in lemlist also remove it from my CRM?
      instructions:
      - text: Delete company {companyId}.
        slots:
          companyId: path.companyId
      - text: Delete company {companyId} with force set to {force} to detach its contacts first.
        slots:
          companyId: path.companyId
          force: query.force
      method: generated
      generated: '2026-10-01'