lemlist · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lemlist Lemwarm API

5 actions 5 updates phrasing extends openapi/lemlist-lemwarm-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for lemlist's API. It is a proposal applied on top of the contract, not a document lemlist publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/lemwarm/{userMailboxId}/start'].post
$.paths['/lemwarm/{userMailboxId}/pause'].post
$.paths['/lemwarm/{userMailboxId}/settings'].get
$.paths['/lemwarm/{userMailboxId}/settings'].patch

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 Lemlist Lemwarm API
  version: 1.0.0
extends: openapi/lemlist-lemwarm-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['/lemwarm/{userMailboxId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start lemwarm on a mailbox
      effect: write
      questions:
      - How do I turn on email warm-up for a new mailbox?
      - Can I start lemwarm again on a mailbox where it was paused?
      instructions:
      - text: Start lemwarm on mailbox {userMailboxId}.
        slots:
          userMailboxId: path.userMailboxId
      - text: Begin warming up mailbox {userMailboxId}.
        slots:
          userMailboxId: path.userMailboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lemwarm/{userMailboxId}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause lemwarm on a mailbox
      effect: write
      questions:
      - Can I temporarily stop warm-up emails from a mailbox?
      - What's the way to halt lemwarm on one inbox?
      instructions:
      - text: Pause lemwarm on mailbox {userMailboxId}.
        slots:
          userMailboxId: path.userMailboxId
      - text: Stop warming mailbox {userMailboxId} for now.
        slots:
          userMailboxId: path.userMailboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lemwarm/{userMailboxId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mailbox's lemwarm settings
      effect: read
      questions:
      - How many warm-up emails per day is my mailbox set to send?
      - What ramp-up is configured for lemwarm on an inbox?
      instructions:
      - text: Show the lemwarm settings for mailbox {userMailboxId}.
        slots:
          userMailboxId: path.userMailboxId
      - text: Get the warm-up volume and ramp-up on {userMailboxId}.
        slots:
          userMailboxId: path.userMailboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lemwarm/{userMailboxId}/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a mailbox's lemwarm volume
      effect: write
      questions:
      - Can I raise the daily maximum of warm-up emails on a mailbox?
      - How do I change how fast lemwarm ramps up?
      instructions:
      - text: Set lemwarm on mailbox {userMailboxId} to at most {warmEmailMax} emails a day.
        slots:
          userMailboxId: path.userMailboxId
          warmEmailMax: requestBody.warmEmailMax
      - text: Change the warm-up ramp-up of {userMailboxId} to {warmEmailRampup}.
        slots:
          userMailboxId: path.userMailboxId
          warmEmailRampup: requestBody.warmEmailRampup
      method: generated
      generated: '2026-10-01'