Lettr
Lettr is an email and messaging platform for transactional delivery, templates, audiences, campaigns, domains, and webhooks.
60 actionsAPI key
What your bot can do in Lettr
Looks up
- Get Audience ContactRetrieve one contact's email, status, custom properties, list memberships, and topic subscriptions by ID.
- Get Audience ListRetrieve one audience list and its current contact count by ID.
- Get Audience PropertyRetrieve one custom contact-property definition and its fallback value.
- Get Audience SegmentRetrieve one dynamic segment's list restriction, complete AND-of-OR condition definition, and cached contact count.
- Get Audience TopicRetrieve one subscription topic's defaults, visibility, and current contact count.
- Get CampaignRetrieve one campaign's name, subject, sender and reply-to configuration, schedule, rendered HTML, lifecycle state, recipient counts, and…
- Get DomainRetrieve one sending domain's send readiness, DNS records, provider detection, and verification status.
- Get EmailRetrieve a sent email's delivery state, recipients, schedule metadata, and events by request ID.
- Get Scheduled EmailRetrieve a scheduled email's current state and events by transmission ID, including after it has been processed.
- Get TemplateRetrieve an email template's metadata, active HTML or editor JSON content, and version counts by slug.
Show 15 more
- Get Template Merge TagsReturn required and optional merge tags for a template's active or specified version before sending with substitution data.
- Get WebhookRetrieve one webhook's target, enabled state, event selection, authentication mode, and latest delivery status.
- List Audience ContactsReturn one cursor-controlled page of contacts, optionally filtered by search text, status, list, or segment.
- List Audience ListsReturn one cursor-controlled page of audience lists with each list's contact count.
- List Audience PropertiesReturn one cursor-controlled page of custom contact-property definitions and fallback values.
- List Audience SegmentsReturn one cursor-controlled page of dynamic audience segments, including their complete AND-of-OR condition definitions, optionally…
- List Audience TopicsReturn one cursor-controlled page of subscription topics with defaults, visibility, and contact counts.
- List Campaign EventsReturn one cursor-controlled page of a campaign's delivery and engagement events, with event, recipient, and time filters.
- List CampaignsReturn one cursor-controlled page of campaigns with complete delivery and engagement statistics, optionally filtered by lifecycle status.
- List DomainsReturn all sending domains with approval, DNS verification, and send-readiness status.
- List Email EventsReturn one cursor-controlled page of delivery and engagement events across sent emails, with event, recipient, transmission, bounce, and…
- List ProjectsReturn one cursor-controlled page of Lettr projects and their IDs for use with template operations.
- List Sent EmailsReturn one cursor-controlled page of sent emails, optionally filtered by recipient and date range.
- List TemplatesReturn one cursor-controlled page of email templates for a project or the team's default project.
- List WebhooksReturn all event webhooks with target, enabled state, event selection, authentication mode, and latest delivery status.
Takes action
- Attach Contacts to ListsAttach every combination of 1-1000 contacts and 1-50 audience lists, processing up to 50,000 contact-list pairs and reporting new and…
- Bulk Create Audience ContactsCreate or recognize up to 1000 normalized, deduplicated contacts.
- Cancel Scheduled EmailCancel a scheduled email before its delivery time.
- Create Audience ContactCreate one audience contact with optional properties and list membership.
- Create Audience Contact With Double Opt-InCreate an unverified audience contact and irreversibly send an external confirmation email.
- Create Audience ListCreate a uniquely named audience list for grouping contacts.
- Create Audience PropertyDefine a custom contact property with an immutable name and value type.
- Create Audience SegmentCreate a dynamic audience segment whose condition groups are ANDed while conditions inside each group are ORed.
- Create Audience TopicCreate a public or private subscription topic with an immutable opt-in or opt-out default.
- Create DomainRegister a sending domain and return the DNS configuration needed to verify it.
Show 25 more
- Create TemplateCreate and publish an email template from either custom HTML or Topol editor JSON, extracting its merge tags.
- Create WebhookCreate an active event webhook using no authentication, HTTP Basic credentials, or OAuth 2 client credentials.
- Delete Audience ContactPermanently delete one audience contact and its associated memberships.
- Delete Audience ListsPermanently delete between 1 and 50 audience lists in one request.
- Delete Audience PropertyPermanently delete a custom contact-property definition.
- Delete Audience SegmentPermanently delete one dynamic audience segment.
- Delete Audience TopicPermanently delete one audience subscription topic.
- Delete DomainPermanently remove a sending domain from Lettr and SparkPost so it can no longer send email.
- Delete TemplatePermanently delete an email template and all of its versions.
- Delete WebhookPermanently remove a webhook so Lettr stops delivering events to it.
- Detach Contacts from ListsDetach every combination of 1-1000 contacts and 1-50 audience lists, reporting removed and absent memberships.
- Publish Template VersionCreate and activate a new version of an existing email template from exactly one of HTML or Topol editor JSON, optionally renaming the…
- Schedule CampaignSchedule a campaign for future delivery or reschedule it.
- Schedule EmailCreate a transactional email scheduled 5 minutes to 3 days in the future.
- Send CampaignImmediately and irreversibly start sending a sendable draft campaign to its resolved audience.
- Send EmailImmediately queue a transactional email to up to 50 recipients using inline content or a Lettr template.
- Unschedule CampaignCancel a scheduled campaign send and return the campaign to draft.
- Update Audience ContactChange a contact's email, subscribed or unsubscribed status, or selected custom property values.
- Update Audience ListRename an audience list while preserving its contacts.
- Update Audience PropertySet or clear a custom contact property's fallback value.
- Update Audience SegmentChange a dynamic segment's name, optional audience-list restriction, or complete AND-of-OR condition definition.
- Update Audience TopicChange a subscription topic's name, description, or public/private visibility.
- Update TemplateRename an email template's metadata without publishing a new version.
- Update WebhookPartially update a webhook's name, callback URL, authentication, selected events, or active state.
- Verify DomainRun Lettr's DNS verification for a registered domain and return DKIM, CNAME, DMARC, SPF, and ownership results.