Skip to main content
Lettr logo
  • Category: transactional email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 60
  • Triggers: 0
  • Slug: LETTR
  • Version: 20261101_00

Tools

Slug: LETTR_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 existing memberships.

Input Parameters

array
required
IDs of 1-50 team-owned audience lists. Every contact in contact_ids is attached to every list.
array
required
IDs of 1-1000 team-owned contacts to attach. Every contact is attached to every list in list_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_BULK_CREATE_AUDIENCE_CONTACTSCreate or recognize up to 1000 normalized, deduplicated contacts, applying shared properties only to new contacts and the optional list to existing contacts too. Valid rows may be written when others fail; the tool returns only created and already-existing counts.

Input Parameters

array
required
Email addresses to normalize, deduplicate, and create (1-1000).
string
Optional team-owned audience list UUID to attach every contact to.
object
Custom property values applied identically only to newly created contacts; existing contacts are not updated. Each value is at most 1000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CANCEL_SCHEDULED_EMAILCancel a scheduled email before its delivery time; cancellation is unavailable once processing has begun.

Input Parameters

string
required
Transmission ID returned by SCHEDULE_EMAIL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_AUDIENCE_CONTACTCreate one audience contact with optional properties and list membership.

Input Parameters

string
required
Contact email address.
string
Optional team-owned audience list UUID to attach the new contact to.
object
Custom values keyed by property names already defined for the team; each value is at most 1000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_AUDIENCE_CONTACT_WITH_DOUBLE_OPT_INCreate an unverified audience contact and irreversibly send an external confirmation email; the contact becomes subscribed only after confirming.

Input Parameters

string
required
Contact email address.
string
Optional team-owned audience list UUID to attach the new contact to.
object
Custom values keyed by property names already defined for the team; each value is at most 1000 characters.
object
required
Required confirmation-email settings. The contact remains unverified until the recipient confirms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_AUDIENCE_LISTCreate a uniquely named audience list for grouping contacts.

Input Parameters

string
required
List name, which must be unique within the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_AUDIENCE_PROPERTYDefine a custom contact property with an immutable name and value type. Changing either later requires deleting and recreating the property.

Input Parameters

string
required
Immutable property key. It must start with a lowercase letter and use only lowercase letters, numbers, and underscores.
string ("string" | "number" | "boolean" | "date" | "json")
required
Immutable value type. The optional fallback_value remains a string and is interpreted according to this type.
string
Optional fallback string interpreted according to property_type, or null for no fallback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_AUDIENCE_SEGMENTCreate a dynamic audience segment whose condition groups are ANDed while conditions inside each group are ORed.

Input Parameters

string
required
Segment name.
string
Optional team-owned audience list restriction. Omit or pass null to evaluate contacts across all lists.
object
required
Dynamic segment definition using ANDed groups of ORed conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_AUDIENCE_TOPICCreate a public or private subscription topic with an immutable opt-in or opt-out default.

Input Parameters

string
required
Topic name.
string ("private" | "public")
Whether the topic appears on public subscription pages.
string
Optional explanation shown for the topic.
string ("opt_in" | "opt_out")
Immutable default for newly created contacts: opt_in requires explicit subscription; opt_out subscribes contacts by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_DOMAINRegister a sending domain and return the DNS configuration needed to verify it.

Input Parameters

string
required
Root or subdomain to register as a sending domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_TEMPLATECreate and publish a transactional email template from custom HTML or Topol editor JSON, extracting its merge tags. JSON templates may remain pending preparation before their HTML is available for sending.

Input Parameters

string
Custom HTML content; provide exactly one of html or editor_json.
string
required
Template name.
integer
Destination folder; defaults to the project’s first folder.
integer
Destination project; defaults to the team’s default project.
string
Topol editor JSON string; provide exactly one of editor_json or html.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_CREATE_WEBHOOKCreate an active event webhook using no authentication, HTTP Basic credentials, or OAuth 2 client credentials.

Input Parameters

string
required
Public HTTPS callback URL where Lettr sends webhook events.
string
required
Human-readable webhook name.
array
Canonical fully-prefixed event names; required when events_mode is selected.
string ("none" | "basic" | "oauth2")
required
Authentication Lettr uses when calling the webhook.
string ("all" | "selected")
required
Receive all event types or only the event types listed in events.
string
Basic-auth password; required when auth_type is basic.
string
Basic-auth username; required when auth_type is basic.
string
OAuth 2 client ID; required when auth_type is oauth2.
string
HTTPS OAuth 2 token URL; required when auth_type is oauth2.
string
OAuth 2 client secret; required when auth_type is oauth2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_AUDIENCE_CONTACTPermanently delete one audience contact and its associated memberships.

Input Parameters

string
required
Contact ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_AUDIENCE_LISTSPermanently delete 1–50 audience lists in one request. If any list has segments restricted to it, none are deleted.

Input Parameters

array
required
IDs of 1-50 audience lists to permanently delete; every list must belong to the connected team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_AUDIENCE_PROPERTYPermanently delete a custom contact-property definition.

Input Parameters

string
required
Property ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_AUDIENCE_SEGMENTPermanently delete one dynamic audience segment.

Input Parameters

string
required
Segment ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_AUDIENCE_TOPICPermanently delete one audience subscription topic.

Input Parameters

string
required
Topic ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_DOMAINPermanently remove a sending domain from Lettr and SparkPost so it can no longer send email.

Input Parameters

string
required
Registered domain to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_TEMPLATEPermanently delete an email template and all of its versions.

Input Parameters

integer
Project containing the template; defaults to the team’s default project.
string
required
Template slug to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DELETE_WEBHOOKPermanently remove a webhook so Lettr stops delivering events to it.

Input Parameters

string
required
Webhook ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_DETACH_CONTACTS_FROM_LISTSDetach every combination of 1-1000 contacts and 1-50 audience lists, reporting removed and absent memberships.

Input Parameters

array
required
IDs of 1-50 team-owned audience lists. Every contact in contact_ids is detached from every list.
array
required
IDs of 1-1000 team-owned contacts to detach. Every contact is detached from every list in list_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_AUDIENCE_CONTACTRetrieve one contact’s email, status, custom properties, list memberships, and topic subscriptions by ID.

Input Parameters

string
required
Contact ID returned by CREATE_AUDIENCE_CONTACT or LIST_AUDIENCE_CONTACTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_AUDIENCE_LISTRetrieve one audience list and its current contact count by ID.

Input Parameters

string
required
Audience list ID returned by CREATE_AUDIENCE_LIST or LIST_AUDIENCE_LISTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_AUDIENCE_PROPERTYRetrieve one custom contact-property definition and its fallback value.

Input Parameters

string
required
Property ID returned by CREATE_AUDIENCE_PROPERTY or LIST_AUDIENCE_PROPERTIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_AUDIENCE_SEGMENTRetrieve one dynamic segment’s list restriction, complete AND-of-OR condition definition, and cached contact count.

Input Parameters

string
required
Segment ID returned by CREATE_AUDIENCE_SEGMENT or LIST_AUDIENCE_SEGMENTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_AUDIENCE_TOPICRetrieve one subscription topic’s defaults, visibility, and current contact count.

Input Parameters

string
required
Topic ID returned by CREATE_AUDIENCE_TOPIC or LIST_AUDIENCE_TOPICS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_CAMPAIGNRetrieve 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.

Input Parameters

string
required
Campaign ID returned by LIST_CAMPAIGNS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_DOMAINRetrieve one sending domain’s send readiness, DNS records, provider detection, and verification status.

Input Parameters

string
required
Registered sending domain name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_EMAILRetrieve 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.

Input Parameters

string
End of the event date range; defaults upstream to now.
string
Start of the event date range; defaults upstream to 10 days ago.
string
required
Request ID returned by SEND_EMAIL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_SCHEDULED_EMAILRetrieve a scheduled email’s state and delivery events using the request ID returned when it was scheduled. Legacy SparkPost transmission IDs for older scheduled emails are also accepted, with an events-derived result.

Input Parameters

string
required
Transmission ID returned by SCHEDULE_EMAIL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_TEMPLATERetrieve an email template’s metadata, active HTML or editor JSON content, and version counts by slug.

Input Parameters

integer
Project containing the template; defaults to the team’s default project.
string
required
Template slug returned by CREATE_TEMPLATE or LIST_TEMPLATES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_TEMPLATE_MERGE_TAGSReturn required and optional merge tags for a template’s active or specified version before sending with substitution data.

Input Parameters

integer
Template version; defaults to the active version.
integer
Project containing the template; defaults to the team’s default project.
string
required
Template slug whose variables should be inspected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_GET_WEBHOOKRetrieve one webhook’s target, enabled state, event selection, authentication mode, and latest delivery status.

Input Parameters

string
required
Webhook ID returned by CREATE_WEBHOOK or LIST_WEBHOOKS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_AUDIENCE_CONTACTSReturn one cursor-controlled page of contacts, optionally filtered by search text, status, list, or segment.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
Search text matched against the contact’s email address or name.
string ("subscribed" | "unsubscribed" | "bounced" | "complained" | "unverified")
Only return contacts with this subscription or delivery status.
string
Only return contacts attached to this team-owned audience list UUID.
integer
Maximum contacts to return in this page (1-100).
string
Only return contacts matching this team-owned audience segment UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_AUDIENCE_LISTSReturn one cursor-controlled page of audience lists with each list’s contact count.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
integer
Maximum audience lists to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_AUDIENCE_PROPERTIESReturn one cursor-controlled page of custom contact-property definitions and fallback values.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
integer
Maximum property definitions to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_AUDIENCE_SEGMENTSReturn one cursor-controlled page of dynamic audience segments, including their complete AND-of-OR condition definitions, optionally filtered by list.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
string
Only return segments restricted to this team-owned audience list UUID.
integer
Maximum segments to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_AUDIENCE_TOPICSReturn one cursor-controlled page of subscription topics with defaults, visibility, and contact counts.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
integer
Maximum topics to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_CAMPAIGN_EVENTSReturn one cursor-controlled page of a campaign’s delivery and engagement events, with event, recipient, and time filters. An empty items page can still have a next_cursor; continue until next_cursor is null.

Input Parameters

string
Only return events for this recipient email address.
integer
Maximum campaign events to return in this page (1-100).
string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
string
Inclusive ISO 8601 upper bound. A date-only value includes the entire UTC day.
string ("injection" | "delivery" | "bounce" | "spam_complaint" | "open" | "click" | "list_unsubscribe")
Only return events of this type.
string
Inclusive ISO 8601 lower bound. A date-only value means the start of that UTC day.
string
required
Campaign whose events should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_CAMPAIGNSReturn one cursor-controlled page of campaigns with complete delivery and engagement statistics, optionally filtered by lifecycle status.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
string ("draft" | "scheduled" | "preparing" | "in_review" | "sending" | "sent" | "failed")
Only return campaigns in this lifecycle state.
integer
Maximum campaigns to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_DOMAINSReturn all sending domains with approval, DNS verification, and send-readiness status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_EMAIL_EVENTSReturn one cursor-controlled page of delivery and engagement events across sent emails, with event, recipient, transmission, bounce, and date filters. Events are retained for about 10 days; the returned start time shows the window actually covered.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
string
End of the ISO 8601 date range; defaults upstream to now.
integer
Maximum events to return in this page (1-100).
string
Start of the ISO 8601 date range; defaults upstream to 10 days ago.
array
Recipient email addresses to include.
array
Event types to include.
array
Bounce classification codes to include.
string
Only include events for this email request or transmission ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_EMAILSReturn one cursor-controlled page of sent emails, optionally filtered by recipient and date range. Sent emails are retained for about 10 days; the returned start time shows the window actually covered.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
string
Include emails sent on or before this ISO 8601 date.
integer
Maximum sent-email records to return in this page (1-100).
string
Include emails sent on or after this ISO 8601 date; defaults upstream to 10 days ago.
string
Only include emails sent to this recipient email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_PROJECTSReturn one cursor-controlled page of Lettr projects and their IDs for use with template operations.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
integer
Maximum projects to return in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_TEMPLATESReturn one cursor-controlled page of email templates for a project or the team’s default project.

Input Parameters

string
Pass the previous response’s next_cursor to fetch the next page; omit for the first page.
integer
Maximum templates to return in this page (1-100).
integer
Project to list; defaults to the team’s default project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_LIST_WEBHOOKSReturn all event webhooks with target, enabled state, event selection, authentication mode, and latest delivery status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_PUBLISH_TEMPLATE_VERSIONCreate and activate a new version of an existing email template from HTML or Topol editor JSON, optionally renaming it. Updated content may remain pending preparation while the previous render is served.

Input Parameters

string
HTML content for the new active version; provide exactly one content format.
string
Optional new template name applied atomically with the published version.
integer
Project containing the template; defaults to the team’s default project.
string
Topol editor JSON for the new active version; provide exactly one content format.
string
required
Template slug to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_SCHEDULE_CAMPAIGNSchedule a campaign for future delivery or reschedule it. The campaign dispatches automatically at that time unless it is unscheduled first.

Input Parameters

string
required
Campaign ID to schedule or reschedule.
string
required
Future delivery time in ISO 8601 format. Include a timezone offset or Z; Lettr interprets a value without an offset as UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_SCHEDULE_EMAILSchedule a transactional email for delivery 5 minutes to 3 days in the future, using HTML, plain text, or a template. Only an email still in the scheduled state can be cancelled; once dispatch has claimed it, it can no longer be cancelled.

Input Parameters

array
Carbon-copy recipient email addresses.
array
required
Recipient email addresses, up to 50.
array
Blind-carbon-copy recipient email addresses.
string
Tracking and analytics tag.
string
HTML body; provide html, text, or template_slug.
string
Plain-text body; provide html, text, or template_slug.
object
Up to 10 custom email headers. Envelope, Lettr-managed, X-MSYS-API, List-Unsubscribe, and List-Unsubscribe-Post headers are forbidden.
object
Email tracking, rendering, and delivery options.
string
Subject line; required unless template_slug is provided.
string
Optional AMP HTML body.
object
Custom string metadata for tracking.
string
Reply-to email address.
string
Sender display name.
string
required
Verified sender email address.
integer
Project containing template_slug; defaults to the team’s default project.
array
File attachments with filename, MIME type, and base64 data.
string
required
Send time in ISO 8601 format with a timezone offset, at least 5 minutes and at most 3 days in the future. Any offset is accepted and converted to UTC before it is sent to Lettr.
string
Reply-to display name.
string
Template whose active HTML and default subject should be used.
integer
Specific template version; defaults to the active version.
object
Values for template substitution in email content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_SEND_CAMPAIGNImmediately and irreversibly start sending a sendable draft campaign to its resolved audience. Only call after confirming the campaign’s audience, subject, sender email, and content. A successful 202 response transitions the campaign asynchronously to preparing and the external send cannot be undone.

Input Parameters

string
required
Draft campaign ID to send now. Before calling, verify its audience, subject, sender email, and content because a successful request starts an irreversible external send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_SEND_EMAILImmediately queue a transactional email to up to 50 recipients using inline content or a Lettr template. This is an irreversible external send.

Input Parameters

array
Carbon-copy recipient email addresses.
array
required
Recipient email addresses, up to 50.
array
Blind-carbon-copy recipient email addresses.
string
Tracking tag, up to 64 characters.
string
HTML body; provide html, text, or template_slug.
string
Plain-text body; provide html, text, or template_slug.
object
Up to 10 custom email headers. Envelope headers and Lettr-managed headers cannot be set.
object
Tracking, transactional, CSS, and substitution options.
string
Subject line; required unless template_slug supplies one.
string
Optional AMP HTML body.
object
Custom string metadata for tracking.
string
Reply-to email address.
string
Sender display name.
string
required
Verified sender email address.
integer
Project containing template_slug; defaults to the team’s default project.
array
Attachments containing a filename, MIME type, and base64 data.
string
Reply-to display name.
string
Template whose active HTML and default subject should be used.
integer
Specific template version; defaults to the active version.
object
Values for template merge tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UNSCHEDULE_CAMPAIGNCancel a scheduled campaign send and return the campaign to draft, or clear a staged delivery time on a draft. Campaigns already preparing or sending cannot be stopped.

Input Parameters

string
required
Currently scheduled campaign ID to return to draft.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_AUDIENCE_CONTACTChange 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.

Input Parameters

string
New email address, which must remain unique within the team.
string ("subscribed" | "unsubscribed")
New subscription status. Bounced, complained, and unverified cannot be assigned with this action.
string
required
Contact ID to update.
object
Custom property values to update by team-defined property name. Each string is at most 1000 characters; set a value to null to remove that property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_AUDIENCE_LISTRename an audience list while preserving its contacts.

Input Parameters

string
required
New list name, which must remain unique within the team.
string
required
Audience list ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_AUDIENCE_PROPERTYSet or clear a custom contact property’s fallback value. Its name and data type cannot be changed.

Input Parameters

string
required
Property ID to update.
string
required
New fallback value, or null to clear the fallback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_AUDIENCE_SEGMENTChange 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.

Input Parameters

string
New segment name.
string
New team-owned list restriction, or null to evaluate contacts across all lists.
object
Complete replacement condition definition.
string
required
Segment ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_AUDIENCE_TOPICChange a subscription topic’s name, description, or public/private visibility. Provide at least one of these mutable fields; setting description to null clears it. Its default subscription behavior cannot be changed.

Input Parameters

string
New topic name.
string
required
Topic ID to update.
string ("private" | "public")
Whether the topic appears on public subscription pages.
string
New topic description; explicitly set this to null to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_TEMPLATERename an email template’s metadata without publishing a new version.

Input Parameters

string
required
New template name.
integer
Project containing the template; defaults to the team’s default project.
string
required
Template slug to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_UPDATE_WEBHOOKPartially update a webhook’s name, callback URL, authentication, selected events, or active state. Authentication credentials are saved only when supplied with the authentication type.

Input Parameters

string
New public HTTPS callback URL.
string
New webhook name.
boolean
Whether Lettr should deliver events to this webhook.
array
Replacement list of canonical fully-prefixed event names.
string ("none" | "basic" | "oauth2")
New callback authentication mode. Setting basic requires auth_username and auth_password; setting oauth2 requires oauth_token_url, oauth_client_id, and oauth_client_secret.
string
required
Webhook ID to update.
string
Replacement Basic-auth password; required when auth_type is basic. Without auth_type, rotates credentials for an existing Basic webhook. This secret is sent to Lettr but never returned by this tool.
string
Replacement Basic-auth username; required when auth_type is basic. Without auth_type, rotates credentials for an existing Basic webhook.
string
Replacement OAuth 2 client ID; required when auth_type is oauth2. Without auth_type, rotates credentials for an existing OAuth 2 webhook.
string
Replacement HTTPS OAuth 2 token endpoint URL; required when auth_type is oauth2. Without auth_type, rotates credentials for an existing OAuth 2 webhook.
string
Replacement OAuth 2 client secret; required when auth_type is oauth2. Without auth_type, rotates credentials for an existing OAuth 2 webhook. This secret is sent to Lettr but never returned by this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LETTR_VERIFY_DOMAINRun Lettr’s DNS verification for a registered domain and return DKIM, CNAME, DMARC, SPF, and ownership results.

Input Parameters

string
required
Registered domain whose current DNS records should be checked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not