Lettr

Retrieve one contact's email, status, custom properties, list memberships, and topic subscriptions by ID.

Retrieve one audience list and its current contact count by ID.

Retrieve one custom contact-property definition and its fallback value.

Retrieve one dynamic segment's list restriction, complete AND-of-OR condition definition, and cached contact count.

Retrieve one subscription topic's defaults, visibility, and current contact count.

Retrieve one campaign's name, subject, sender and reply-to configuration, schedule, rendered HTML, lifecycle state, recipient counts, and engagement statistics. The campaign's audience definition is not returned.

Retrieve one sending domain's send readiness, DNS records, provider detection, and verification status.

Retrieve a sent email's delivery state, recipients, schedule metadata, and events by request ID. The configurable event date range defaults to the last 10 days, not the email's complete event history.

Retrieve a scheduled email's current state and events by transmission ID, including after it has been processed.

Retrieve an email template's metadata, active HTML or editor JSON content, and version counts by slug.

Create one audience contact with optional properties and list membership.

Create a uniquely named audience list for grouping contacts.

Define a custom contact property with an immutable name and value type. Changing either later requires deleting and recreating the property.

Create a dynamic audience segment whose condition groups are ANDed while conditions inside each group are ORed.

Create a public or private subscription topic with an immutable opt-in or opt-out default.

Register a sending domain and return the DNS configuration needed to verify it.

Create and publish an email template from either custom HTML or Topol editor JSON, extracting its merge tags.

Create an active event webhook using no authentication, HTTP Basic credentials, or OAuth 2 client credentials.

Create a transactional email scheduled 5 minutes to 3 days in the future; it remains cancellable until processed.

Attach every combination of 1-1000 contacts and 1-50 audience lists, processing up to 50,000 contact-list pairs and reporting new and existing memberships.

Create or recognize up to 1000 normalized, deduplicated contacts. Shared properties affect only newly created contacts; list_id applies to all contacts, including those that already exist.

Detach every combination of 1-1000 contacts and 1-50 audience lists, reporting removed and absent memberships.

Create and activate a new version of an existing email template from exactly one of HTML or Topol editor JSON, optionally renaming the template atomically.

Schedule a campaign for future delivery or reschedule it. The campaign dispatches automatically at that time unless it is unscheduled first.

Cancel a scheduled campaign send and return the campaign to draft. The campaign must still be scheduled; this cannot stop one already preparing or sending.

Change a contact's email, subscribed or unsubscribed status, or selected custom property values. Provide at least one of email, status, or properties; a null value inside properties removes that property.

Rename an audience list while preserving its contacts.

Set or clear a custom contact property's fallback value. Its name and data type cannot be changed.

Change a dynamic segment's name, optional audience-list restriction, or complete AND-of-OR condition definition. Provide at least one of these mutable fields; setting list_id to null removes the list restriction.

Cancel a scheduled email before its delivery time; cancellation is unavailable once processing has begun.

Create an unverified audience contact and irreversibly send an external confirmation email; the contact becomes subscribed only after confirming.

Permanently delete one audience contact and its associated memberships.

Permanently delete between 1 and 50 audience lists in one request.

Permanently delete a custom contact-property definition.

Permanently delete one dynamic audience segment.

Permanently delete one audience subscription topic.

Permanently remove a sending domain from Lettr and SparkPost so it can no longer send email.

Permanently delete an email template and all of its versions.

Permanently remove a webhook so Lettr stops delivering events to it.