> ## Documentation Index
> Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLAUDE

# Repo guidelines for AI agents

**This is a public API documentation repo.** Everything you write lands on
[https://developer.lemlist.com](https://developer.lemlist.com) and is visible on GitHub to anyone. Treat every
edit as if you were publishing it to the internet — because you are.

## Never paste real data into samples

When writing example payloads (OpenAPI `example` fields, MDX code blocks,
JSON responses, email HTML bodies), use **obvious placeholders only**. Never
copy from real API responses, production dumps, your own lemlist workspace,
or a teammate's workspace.

### What counts as real data (forbidden)

* Any email on a lemlist-owned domain, except the public `support@lemlist.com`.
* First or last names of real people (lemlist employees, lemlist customers,
  anyone you encountered in a real API response).
* Entity IDs that look real — i.e. a `<prefix>_<random mixed-case string>` that
  doesn't contain an obvious-fake marker (`Example`, `Fake`, `A1B2C3`, repeated
  digits like `123`, etc.). If it looks like something a production system
  would emit, assume it is.
* Real company names / domains / LinkedIn handles / calendar handles / S3
  URLs / webhook URLs — anything you could copy from an enrichment response
  or a tracking link.
* Real email thread content, message bodies, subject lines.

### Placeholder conventions (use these)

| Kind      | Placeholder                                                                                                                                                                                                      |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entity ID | Generate a synthetic ID matching the lemlist format (`<prefix>_<17 mixed-case alphanumerics>`) **from scratch**. Don't reuse or slightly-edit an ID from a real response — generate a new random body each time. |
| Email     | `john@example.com`, `jane@example.com`, `alex@example.com`                                                                                                                                                       |
| Name      | John Doe, Jane Smith, Alex Johnson                                                                                                                                                                               |
| Company   | Acme Inc, Example Corp                                                                                                                                                                                           |
| Domain    | `example.com`, `acme.com`                                                                                                                                                                                        |
| URL       | `https://example.com/...`                                                                                                                                                                                        |

The key for IDs is *origin*, not shape: an ID you invented is fine; an ID
you pasted from somewhere is not, even if "it looked synthetic enough".

## Same rules for commits, PR titles/descriptions, and review comments

Commit messages, PR titles and bodies, and PR/issue comments are all
public on this repo. Apply the same rules there: don't name real
employees, don't cite real entity IDs (even in "look what leaked"
comments), don't quote real emails or URLs. Describe in generic terms
("a teammate", "a production-looking ID", "a real customer's domain").

## If you're adapting a real API response

Run through this checklist before committing:

1. Replace every ID with a freshly-generated synthetic one (don't keep the original characters).
2. Replace every email with an `@example.com` variant.
3. Replace every first/last name with a generic (John Doe, Jane Smith, …).
4. Replace real company names, URLs, domains, LinkedIn slugs, webhook URLs.
5. Read your full diff line by line before committing. If any string feels
   like it could point back to a real person, team, or system — replace it.

## Why this matters

Past samples in this repo leaked employee names, personal emails, and
production entity IDs — scraped from real API responses and pasted into
OpenAPI samples. Those samples are public the moment they are pushed.
There is no CI gate that can un-publish a leaked commit on a public repo.
Prevention is the only control.