lemlist · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for lemlist Email Accounts API

4 actions 4 updates phrasing extends openapi/lemlist-email-accounts-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 4

$.info

$.paths['/user/email-accounts'].post

$.paths['/user/email-accounts/{emailAccountId}'].delete

$.paths['/user/email-accounts/{emailAccountId}/test'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for lemlist Email Accounts API
  version: 1.0.0
extends: openapi/lemlist-email-accounts-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['/user/email-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an SMTP/IMAP email account
      effect: write
      questions:
      - How do I connect a custom mailbox to lemlist using SMTP and IMAP settings?
      - Can I connect a sending account on behalf of a teammate?
      instructions:
      - text: Connect {sender_email} as {sender_name} using SMTP {smtp_host}:{smtp_port}, login {smtp_login}, password {smtp_password}.
        slots:
          sender_email: requestBody.sender_email
          sender_name: requestBody.sender_name
          smtp_host: requestBody.smtp_host
          smtp_port: requestBody.smtp_port
          smtp_login: requestBody.smtp_login
          smtp_password: requestBody.smtp_password
      - text: Set the new mailbox's IMAP to {imap_host}:{imap_port}, login {imap_login}, password {imap_password}.
        slots:
          imap_host: requestBody.imap_host
          imap_port: requestBody.imap_port
          imap_login: requestBody.imap_login
          imap_password: requestBody.imap_password
      - text: Add mailbox {sender_email} and assign it to teammate {userId}.
        slots:
          sender_email: requestBody.sender_email
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/email-accounts/{emailAccountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disconnect an email account
      effect: destructive
      questions:
      - How do I disconnect a mailbox I no longer send from?
      - Can I remove a sending email account from my team?
      instructions:
      - text: Disconnect email account {emailAccountId}.
        slots:
          emailAccountId: path.emailAccountId
      - text: Remove mailbox {emailAccountId} from lemlist.
        slots:
          emailAccountId: path.emailAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/email-accounts/{emailAccountId}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a connected email account
      effect: read
      questions:
      - Is my connected mailbox's SMTP and IMAP connection still working?
      - Can I check a sending account's connection before launching a campaign?
      instructions:
      - text: Test the connection of email account {emailAccountId}.
        slots:
          emailAccountId: path.emailAccountId
      - text: Check that mailbox {emailAccountId} can still send and receive.
        slots:
          emailAccountId: path.emailAccountId
      method: generated
      generated: '2026-10-01'