lemlist · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lemlist Activities API

4 actions 4 updates phrasing extends openapi/lemlist-activities-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['/activities/'].get

$.paths['/activities'].get

$.paths['/activities/{activityId}/recording-transcript'].delete

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 Activities API
  version: 1.0.0
extends: openapi/lemlist-activities-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['/activities/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve activities with the original v1 endpoint
      effect: read
      questions:
      - Can I still pull campaign activities through the older v1 activities endpoint?
      - Which legacy activity call returns up to 100 events filtered by type and lead?
      instructions:
      - text: Using the legacy v1 activities endpoint, list activities for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      - text: Pull legacy v1 activities of type {type} for lead {leadId}.
        slots:
          type: query.type
          leadId: query.leadId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get campaign activities within a date range
      effect: read
      questions:
      - How do I see every email open, reply and click logged in lemlist between two dates?
      - Can I filter v2 activities to only the first activity of each lead?
      - What is the maximum number of activities returned per page?
      instructions:
      - text: Get v2 activities for campaign {campaignId} created between {minDate} and {maxDate}.
        slots:
          campaignId: query.campaignId
          minDate: query.minDate
          maxDate: query.maxDate
      - text: List {type} activities with API version {version}.
        slots:
          type: query.type
          version: query.version
      - text: Show the {limit} most recent v2 activities for lead {leadId}, skipping {offset}.
        slots:
          limit: query.limit
          leadId: query.leadId
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/{activityId}/recording-transcript'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a call recording and its transcript
      effect: destructive
      questions:
      - Can I remove the recording and transcript attached to a call activity?
      - How do I erase a recorded conversation from a lead's activity history?
      instructions:
      - text: Delete the recording and transcript of activity {activityId}.
        slots:
          activityId: path.activityId
      - text: Wipe the call recording stored on activity {activityId}.
        slots:
          activityId: path.activityId
      method: generated
      generated: '2026-10-01'