# Lekalao > Lekalao documentation: lists, campaigns, automations and transactional e-mails. ## User guide ### Getting started - [Welcome to Lekalao](https://docs.lekalao.com/index.md): Lists, campaigns, automations and transactional e-mails, on your own sending provider. - [Getting started](https://docs.lekalao.com/guide/quickstart.md): From an empty installation to the first campaign sent. - [Key ideas](https://docs.lekalao.com/guide/concepts.md): Lekalao's words, and how they fit together. - [Finding your way around](https://docs.lekalao.com/guide/interface.md): The navigation, the command palette and the keyboard shortcuts. - [Dashboard](https://docs.lekalao.com/guide/dashboard.md): How your audience and your latest sends are doing, at a glance. ### Contacts - [Lists](https://docs.lekalao.com/contacts/lists.md): Create a list and set everything that happens when someone joins it. - [Subscribers](https://docs.lekalao.com/contacts/subscribers.md): Search, filter, change and act on the people of a list. - [Tags](https://docs.lekalao.com/contacts/tags.md): Label your subscribers, and let each of them choose their subjects. - [Segments](https://docs.lekalao.com/contacts/segments.md): Saved filters, to write to the right people. - [Import and export](https://docs.lekalao.com/contacts/import-export.md): Bring an existing list in, and take a copy out. - [Subscription forms](https://docs.lekalao.com/contacts/subscription-forms.md): Subscribe people from your own site, in HTML or in JavaScript. - [Public pages](https://docs.lekalao.com/contacts/public-pages.md): What your subscribers see: confirmation, unsubscribe, preferences, archive. - [Suppression list](https://docs.lekalao.com/contacts/suppression-list.md): The addresses your team never writes to again. ### Content - [The editors](https://docs.lekalao.com/content/editors.md): Visual blocks, Markdown, HTML or MJML: choosing how to write. - [Templates](https://docs.lekalao.com/content/templates.md): One shared layout, and campaigns that only fill in the content. - [Personalisation](https://docs.lekalao.com/content/personalization.md): Variables, conditions and loops, to write to each person. - [Writing in several languages](https://docs.lekalao.com/content/languages.md): One campaign, one version per language, each person gets theirs. - [Brand](https://docs.lekalao.com/content/brand.md): The team's colours, typefaces and logo, applied everywhere. - [Images and saved pieces](https://docs.lekalao.com/content/media-and-blocks.md): The team's media library, and the blocks you use again. - [Preview and checks](https://docs.lekalao.com/content/checks.md): See the e-mail as your readers will, and fix it before sending. ### Campaigns - [Create a campaign](https://docs.lekalao.com/campaigns/create.md): The creation panel, then the settings: recipients, sender, tracking. - [Send a campaign](https://docs.lekalao.com/campaigns/sending.md): Check it, test it, send or schedule it, then follow the send. - [A/B tests](https://docs.lekalao.com/campaigns/ab-testing.md): Try up to five versions on a sample, and send the best one to the rest. - [Statistics](https://docs.lekalao.com/campaigns/statistics.md): Reach, reception, revenue, the click map and the comparison of campaigns. - [RSS campaigns](https://docs.lekalao.com/campaigns/rss.md): Write to your list on its own, whenever your blog publishes. ### Automations - [Automations](https://docs.lekalao.com/automations/overview.md): Journeys of e-mails that run on their own. - [Triggers](https://docs.lekalao.com/automations/triggers.md): What brings a subscriber into an automation. - [Actions](https://docs.lekalao.com/automations/actions.md): Every step of a journey, and its settings. - [Automation e-mails](https://docs.lekalao.com/automations/emails.md): Written once, sent by the automations to each subscriber. ### Transactional e-mails - [Transactional e-mails](https://docs.lekalao.com/transactional/overview.md): The e-mails your applications send to one person. - [Transactional templates](https://docs.lekalao.com/transactional/templates.md): Write the e-mail once, and let your applications call it by name. - [The log](https://docs.lekalao.com/transactional/log.md): Every transactional e-mail sent, its content, what became of it. ### Deliverability - [Mailers](https://docs.lekalao.com/deliverability/mailers.md): Wire up SMTP, Amazon SES, Postmark, Mailgun, SendGrid, Brevo or Resend. - [Sending domains](https://docs.lekalao.com/deliverability/domains.md): SPF, DKIM, DMARC and a tracking host: proving your e-mails really come from you. - [Provider feedback](https://docs.lekalao.com/deliverability/feedback.md): Deliveries, bounces and complaints: what the provider sends back, and what Lekalao does with it. - [Sending safety](https://docs.lekalao.com/deliverability/sending-safety.md): What Lekalao does to protect your sender reputation, and what is left for you to do. ### Account and team - [Team and roles](https://docs.lekalao.com/account/team.md): Invite people, choose their role, work in several teams. - [Profile and security](https://docs.lekalao.com/account/profile-and-security.md): Your name, your password, two-factor authentication, passkeys, the theme and the language. - [Billing](https://docs.lekalao.com/account/billing.md): Plans, usage and payments, on an online Lekalao offer. - [Privacy and the GDPR](https://docs.lekalao.com/account/privacy.md): Consent records, the right of access, the right to be forgotten and retention limits. - [API tokens and webhooks](https://docs.lekalao.com/account/integrations.md): Give your applications access, and tell them what happens. - [General settings and maintenance](https://docs.lekalao.com/account/maintenance.md): Name, public URL, default sender, and how healthy Lekalao is. ## Developers ### The API - [Introduction](https://docs.lekalao.com/developers/introduction.md): What your application can do with Lekalao, and where to start. - [Authentication](https://docs.lekalao.com/developers/authentication.md): API tokens: creating them, using them, keeping them safe. - [Conventions](https://docs.lekalao.com/developers/conventions.md): Format, identifiers, pagination, rate limits, idempotency and CORS. - [Errors](https://docs.lekalao.com/developers/errors.md): Response codes, the shape of an error, and what to do about each one. ### Recipes - [Subscribers](https://docs.lekalao.com/developers/subscribers.md): Subscribe, keep up to date, tag and unsubscribe from your own application. - [Segments](https://docs.lekalao.com/developers/segments.md): Describe an audience in JSON: groups, rules and operators. - [Campaigns](https://docs.lekalao.com/developers/campaigns.md): Create a campaign from your CMS, test it, send it and follow its figures. - [Transactional e-mails](https://docs.lekalao.com/developers/transactional.md): Order confirmations, invoices, password resets: one call per e-mail. - [Automations](https://docs.lekalao.com/developers/automations.md): Put someone into a journey from your own application. - [Sales](https://docs.lekalao.com/developers/conversions.md): Report what your e-mails earn, so each campaign shows its revenue. ### Integrations - [Webhooks](https://docs.lekalao.com/developers/webhooks.md): Receive Lekalao's events, and check that they really come from it. - [Laravel transport](https://docs.lekalao.com/developers/laravel-transport.md): Send a Laravel application's e-mails through Lekalao, without touching its code. - [SMTP relay](https://docs.lekalao.com/developers/smtp-relay.md): Plug in software that only knows how to send over SMTP. - [Forms](https://docs.lekalao.com/developers/forms.md): Subscribe from a static site, a React application or a server, without a token. ## API reference ### Overview - [API reference](https://docs.lekalao.com/api-reference/introduction.md): Every route of Lekalao's REST API, with a playground. ### Lists - [List the e-mail lists](https://docs.lekalao.com/api-reference/lists/list-the-e-mail-lists.md): Every list of the token's team, paginated. - [Create a list](https://docs.lekalao.com/api-reference/lists/create-a-list.md) - [Read one list](https://docs.lekalao.com/api-reference/lists/read-one-list.md) - [Change a list](https://docs.lekalao.com/api-reference/lists/change-a-list.md): Only the fields you send change. - [Delete a list](https://docs.lekalao.com/api-reference/lists/delete-a-list.md): Deletes the list **and everyone on it**. This cannot be undone. ### Subscribers - [List the subscribers of a list](https://docs.lekalao.com/api-reference/subscribers/list-the-subscribers-of-a-list.md) - [Subscribe an address](https://docs.lekalao.com/api-reference/subscribers/subscribe-an-address.md): Subscribes the address, or updates the person if they are already on the list. On a double opt-in list the subscriber stays "unconfirmed" and receives the confirmation e-mail, unless `skip_confirmation` is true. An address on the suppression list is refused. - [Subscribe a batch of addresses](https://docs.lekalao.com/api-reference/subscribers/subscribe-a-batch-of-addresses.md): Up to 1,000 subscribers in one call. Up to 100, the work happens at once and the answer reports line by line (200). Past that, the batch goes to the background like an import and the answer is an import to follow (202). One line in error does not lose the others. - [Read one subscriber](https://docs.lekalao.com/api-reference/subscribers/read-one-subscriber.md) - [Change a subscriber](https://docs.lekalao.com/api-reference/subscribers/change-a-subscriber.md): Fields left out or null change nothing. `tags`, when present, **replaces** the whole set of tags. - [Delete a subscriber](https://docs.lekalao.com/api-reference/subscribers/delete-a-subscriber.md): Deletes the record. To keep the proof that they left, prefer unsubscribing; for the right to be forgotten, use the erasure in the interface. - [Unsubscribe someone](https://docs.lekalao.com/api-reference/subscribers/unsubscribe-someone.md) - [Subscribe someone again](https://docs.lekalao.com/api-reference/subscribers/subscribe-someone-again.md): Subscribes again without asking for confirmation. Refused for a blocked address. - [Send the confirmation e-mail again](https://docs.lekalao.com/api-reference/subscribers/send-the-confirmation-e-mail-again.md) - [Add or remove tags](https://docs.lekalao.com/api-reference/subscribers/add-or-remove-tags.md): A tag that does not exist on the list yet is created. Automations triggered by a tag start. ### Tags - [List the tags of a list](https://docs.lekalao.com/api-reference/tags/list-the-tags-of-a-list.md) - [Create a tag](https://docs.lekalao.com/api-reference/tags/create-a-tag.md) - [Delete a tag](https://docs.lekalao.com/api-reference/tags/delete-a-tag.md): The tag is taken off every subscriber who carried it. ### Segments - [List the segments of a list](https://docs.lekalao.com/api-reference/segments/list-the-segments-of-a-list.md) - [Create a segment](https://docs.lekalao.com/api-reference/segments/create-a-segment.md): Conditions are checked as in the builder of the interface: an unknown type or operator is refused, with the path of the rule at fault. - [Read one segment](https://docs.lekalao.com/api-reference/segments/read-one-segment.md) - [Change a segment](https://docs.lekalao.com/api-reference/segments/change-a-segment.md) - [Delete a segment](https://docs.lekalao.com/api-reference/segments/delete-a-segment.md) ### Imports - [List the imports of a list](https://docs.lekalao.com/api-reference/imports/list-the-imports-of-a-list.md) - [Import a file](https://docs.lekalao.com/api-reference/imports/import-a-file.md): A CSV, TXT or XLSX file of 20 MB at most, with a header row. Without `mapping`, columns are recognised by their headers (email, first name, last name, tags, time zone, language…). One column must hold the e-mail address. The work happens in the background: follow the import in the answer. - [Follow an import](https://docs.lekalao.com/api-reference/imports/follow-an-import.md): Also serves a batch of more than 100 subscribers handed to the queue. ### Templates - [List the templates](https://docs.lekalao.com/api-reference/templates/list-the-templates.md) - [Create a template](https://docs.lekalao.com/api-reference/templates/create-a-template.md): A template carries the layout; campaigns fill its editable area `{{ zone.main }}`. - [Read one template](https://docs.lekalao.com/api-reference/templates/read-one-template.md) - [Change a template](https://docs.lekalao.com/api-reference/templates/change-a-template.md) - [Delete a template](https://docs.lekalao.com/api-reference/templates/delete-a-template.md): Campaigns already sent keep their content. ### Campaigns - [List the campaigns](https://docs.lekalao.com/api-reference/campaigns/list-the-campaigns.md) - [Create a campaign](https://docs.lekalao.com/api-reference/campaigns/create-a-campaign.md): The campaign is born a draft. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface. - [Read one campaign](https://docs.lekalao.com/api-reference/campaigns/read-one-campaign.md): While it sends, the figures are worked out as you read them. - [Delete a campaign](https://docs.lekalao.com/api-reference/campaigns/delete-a-campaign.md) - [Send now](https://docs.lekalao.com/api-reference/campaigns/send-now.md): Checks first that the campaign is ready (list, subject, content, recipients, an allowed sender). The e-mails then leave through the queue, at the provider's pace. - [Send a test](https://docs.lekalao.com/api-reference/campaigns/send-a-test.md): Sends the campaign rendered with sample values, the subject prefixed with "[Test]". No statistics are counted. ### Automations - [List the automations](https://docs.lekalao.com/api-reference/automations/list-the-automations.md): The team's automations, most recent first, with the uuid the route that puts someone in expects. - [Put someone into an automation](https://docs.lekalao.com/api-reference/automations/put-someone-into-an-automation.md): Subscribes the address to the automation's list without asking for confirmation, then puts it on the journey and runs the first actions at once. Works whatever the automation's trigger is, as long as it is running. ### Transactional e-mails - [Send a transactional e-mail](https://docs.lekalao.com/api-reference/transactional-e-mails/send-a-transactional-e-mail.md): Sends from a transactional template (`template`) or from HTML you supply (`html`). The e-mail is logged, followed (opens and clicks when the template asks for it) and counted against the allowance. Without `to`, the template's default recipients are used. - [List transactional e-mails](https://docs.lekalao.com/api-reference/transactional-e-mails/list-transactional-e-mails.md) - [Read one transactional e-mail](https://docs.lekalao.com/api-reference/transactional-e-mails/read-one-transactional-e-mail.md) - [Send a transactional e-mail again](https://docs.lekalao.com/api-reference/transactional-e-mails/send-a-transactional-e-mail-again.md): Sends it again, to the same recipients, with the same variables and the same language. A new e-mail is logged. ### Revenue - [Report a sale](https://docs.lekalao.com/api-reference/revenue/report-a-sale.md): Attaches a sale to the subscriber, then to the last e-mail they actually opened or clicked inside the attribution window (14 days by default; a click beats an open). The same `reference` sent twice stays one sale (200 instead of 201). - [Remove a sale](https://docs.lekalao.com/api-reference/revenue/remove-a-sale.md): For a refund or a cancellation: the revenue of the campaigns is worked out again. ### Platform - [The installation's OpenAPI document](https://docs.lekalao.com/api-reference/platform/the-installations-openapi-document.md): Served by every installation, without a token. Its paths come from the real routes; a test refuses any route that is not described. - [Check a licence key](https://docs.lekalao.com/api-reference/platform/check-a-licence-key.md): Called every week by a self-hosted installation, without a token: the signed key is its own proof. Limited to 30 calls a minute. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [French (104 pages)](https://docs.lekalao.com/_llms/fr.md): Documentation for French.