> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Lettr

> Lettr is an email and messaging platform for transactional delivery, templates, audiences, campaigns, domains, and webhooks.

![Lettr logo](https://mintcdn.com/composio-preview/ufpARLIsio16odJB/images/toolkits/lettr.svg?fit=max\&auto=format\&n=ufpARLIsio16odJB\&q=85\&s=f9f297b68d83a02f995b83367d7955bb)

* **Category:** transactional email
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 60
* **Triggers:** 0
* **Slug:** `LETTR`
* **Version:** 20261101\_00

## Tools

> [accordion] Attach Contacts to Lists
>
> **Slug:** `LETTR_ATTACH_CONTACTS_TO_LISTS`
>
> 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.
>
> #### Input Parameters
>
> **list\_ids** `array` *required*
>
> IDs of 1-50 team-owned audience lists. Every contact in contact\_ids is attached to every list.
>
> **contact\_ids** `array` *required*
>
> IDs of 1-1000 team-owned contacts to attach. Every contact is attached to every list in list\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Create Audience Contacts
>
> **Slug:** `LETTR_BULK_CREATE_AUDIENCE_CONTACTS`
>
> Create 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
>
> **emails** `array` *required*
>
> Email addresses to normalize, deduplicate, and create (1-1000).
>
> **list\_id** `string`
>
> Optional team-owned audience list UUID to attach every contact to.
>
> **properties** `object`
>
> Custom property values applied identically only to newly created contacts; existing contacts are not updated. Each value is at most 1000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Scheduled Email
>
> **Slug:** `LETTR_CANCEL_SCHEDULED_EMAIL`
>
> Cancel a scheduled email before its delivery time; cancellation is unavailable once processing has begun.
>
> #### Input Parameters
>
> **transmission\_id** `string` *required*
>
> Transmission ID returned by SCHEDULE\_EMAIL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Audience Contact
>
> **Slug:** `LETTR_CREATE_AUDIENCE_CONTACT`
>
> Create one audience contact with optional properties and list membership.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Contact email address.
>
> **list\_id** `string`
>
> Optional team-owned audience list UUID to attach the new contact to.
>
> **properties** `object`
>
> Custom values keyed by property names already defined for the team; each value is at most 1000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Audience Contact With Double Opt-In
>
> **Slug:** `LETTR_CREATE_AUDIENCE_CONTACT_WITH_DOUBLE_OPT_IN`
>
> Create an unverified audience contact and irreversibly send an external confirmation email; the contact becomes subscribed only after confirming.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Contact email address.
>
> **list\_id** `string`
>
> Optional team-owned audience list UUID to attach the new contact to.
>
> **properties** `object`
>
> Custom values keyed by property names already defined for the team; each value is at most 1000 characters.
>
> **double\_opt\_in** `object` *required*
>
> Required confirmation-email settings. The contact remains unverified until the recipient confirms.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Audience List
>
> **Slug:** `LETTR_CREATE_AUDIENCE_LIST`
>
> Create a uniquely named audience list for grouping contacts.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> List name, which must be unique within the team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Audience Property
>
> **Slug:** `LETTR_CREATE_AUDIENCE_PROPERTY`
>
> Define a custom contact property with an immutable name and value type. Changing either later requires deleting and recreating the property.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Immutable property key. It must start with a lowercase letter and use only lowercase letters, numbers, and underscores.
>
> **property\_type** `string ("string" | "number" | "boolean" | "date" | "json")` *required*
>
> Immutable value type. The optional fallback\_value remains a string and is interpreted according to this type.
>
> **fallback\_value** `string`
>
> Optional fallback string interpreted according to property\_type, or null for no fallback.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Audience Segment
>
> **Slug:** `LETTR_CREATE_AUDIENCE_SEGMENT`
>
> Create a dynamic audience segment whose condition groups are ANDed while conditions inside each group are ORed.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Segment name.
>
> **list\_id** `string`
>
> Optional team-owned audience list restriction. Omit or pass null to evaluate contacts across all lists.
>
> **conditions** `object` *required*
>
> Dynamic segment definition using ANDed groups of ORed conditions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Audience Topic
>
> **Slug:** `LETTR_CREATE_AUDIENCE_TOPIC`
>
> Create a public or private subscription topic with an immutable opt-in or opt-out default.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Topic name.
>
> **visibility** `string ("private" | "public")`
>
> Whether the topic appears on public subscription pages.
>
> **description** `string`
>
> Optional explanation shown for the topic.
>
> **default\_subscription** `string ("opt_in" | "opt_out")`
>
> Immutable default for newly created contacts: opt\_in requires explicit subscription; opt\_out subscribes contacts by default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Domain
>
> **Slug:** `LETTR_CREATE_DOMAIN`
>
> Register a sending domain and return the DNS configuration needed to verify it.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Root or subdomain to register as a sending domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template
>
> **Slug:** `LETTR_CREATE_TEMPLATE`
>
> Create 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
>
> **html** `string`
>
> Custom HTML content; provide exactly one of html or editor\_json.
>
> **name** `string` *required*
>
> Template name.
>
> **folder\_id** `integer`
>
> Destination folder; defaults to the project's first folder.
>
> **project\_id** `integer`
>
> Destination project; defaults to the team's default project.
>
> **editor\_json** `string`
>
> Topol editor JSON string; provide exactly one of editor\_json or html.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook
>
> **Slug:** `LETTR_CREATE_WEBHOOK`
>
> Create an active event webhook using no authentication, HTTP Basic credentials, or OAuth 2 client credentials.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public HTTPS callback URL where Lettr sends webhook events.
>
> **name** `string` *required*
>
> Human-readable webhook name.
>
> **events** `array`
>
> Canonical fully-prefixed event names; required when events\_mode is selected.
>
> **auth\_type** `string ("none" | "basic" | "oauth2")` *required*
>
> Authentication Lettr uses when calling the webhook.
>
> **events\_mode** `string ("all" | "selected")` *required*
>
> Receive all event types or only the event types listed in events.
>
> **auth\_password** `string`
>
> Basic-auth password; required when auth\_type is basic.
>
> **auth\_username** `string`
>
> Basic-auth username; required when auth\_type is basic.
>
> **oauth\_client\_id** `string`
>
> OAuth 2 client ID; required when auth\_type is oauth2.
>
> **oauth\_token\_url** `string`
>
> HTTPS OAuth 2 token URL; required when auth\_type is oauth2.
>
> **oauth\_client\_secret** `string`
>
> OAuth 2 client secret; required when auth\_type is oauth2.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Audience Contact
>
> **Slug:** `LETTR_DELETE_AUDIENCE_CONTACT`
>
> Permanently delete one audience contact and its associated memberships.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Audience Lists
>
> **Slug:** `LETTR_DELETE_AUDIENCE_LISTS`
>
> Permanently delete 1–50 audience lists in one request. If any list has segments restricted to it, none are deleted.
>
> #### Input Parameters
>
> **list\_ids** `array` *required*
>
> IDs of 1-50 audience lists to permanently delete; every list must belong to the connected team.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Audience Property
>
> **Slug:** `LETTR_DELETE_AUDIENCE_PROPERTY`
>
> Permanently delete a custom contact-property definition.
>
> #### Input Parameters
>
> **property\_id** `string` *required*
>
> Property ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Audience Segment
>
> **Slug:** `LETTR_DELETE_AUDIENCE_SEGMENT`
>
> Permanently delete one dynamic audience segment.
>
> #### Input Parameters
>
> **segment\_id** `string` *required*
>
> Segment ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Audience Topic
>
> **Slug:** `LETTR_DELETE_AUDIENCE_TOPIC`
>
> Permanently delete one audience subscription topic.
>
> #### Input Parameters
>
> **topic\_id** `string` *required*
>
> Topic ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Domain
>
> **Slug:** `LETTR_DELETE_DOMAIN`
>
> Permanently remove a sending domain from Lettr and SparkPost so it can no longer send email.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Registered domain to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template
>
> **Slug:** `LETTR_DELETE_TEMPLATE`
>
> Permanently delete an email template and all of its versions.
>
> #### Input Parameters
>
> **project\_id** `integer`
>
> Project containing the template; defaults to the team's default project.
>
> **template\_slug** `string` *required*
>
> Template slug to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `LETTR_DELETE_WEBHOOK`
>
> Permanently remove a webhook so Lettr stops delivering events to it.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> Webhook ID to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach Contacts from Lists
>
> **Slug:** `LETTR_DETACH_CONTACTS_FROM_LISTS`
>
> Detach every combination of 1-1000 contacts and 1-50 audience lists, reporting removed and absent memberships.
>
> #### Input Parameters
>
> **list\_ids** `array` *required*
>
> IDs of 1-50 team-owned audience lists. Every contact in contact\_ids is detached from every list.
>
> **contact\_ids** `array` *required*
>
> IDs of 1-1000 team-owned contacts to detach. Every contact is detached from every list in list\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience Contact
>
> **Slug:** `LETTR_GET_AUDIENCE_CONTACT`
>
> Retrieve one contact's email, status, custom properties, list memberships, and topic subscriptions by ID.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID returned by CREATE\_AUDIENCE\_CONTACT or LIST\_AUDIENCE\_CONTACTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience List
>
> **Slug:** `LETTR_GET_AUDIENCE_LIST`
>
> Retrieve one audience list and its current contact count by ID.
>
> #### Input Parameters
>
> **list\_id** `string` *required*
>
> Audience list ID returned by CREATE\_AUDIENCE\_LIST or LIST\_AUDIENCE\_LISTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience Property
>
> **Slug:** `LETTR_GET_AUDIENCE_PROPERTY`
>
> Retrieve one custom contact-property definition and its fallback value.
>
> #### Input Parameters
>
> **property\_id** `string` *required*
>
> Property ID returned by CREATE\_AUDIENCE\_PROPERTY or LIST\_AUDIENCE\_PROPERTIES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience Segment
>
> **Slug:** `LETTR_GET_AUDIENCE_SEGMENT`
>
> Retrieve one dynamic segment's list restriction, complete AND-of-OR condition definition, and cached contact count.
>
> #### Input Parameters
>
> **segment\_id** `string` *required*
>
> Segment ID returned by CREATE\_AUDIENCE\_SEGMENT or LIST\_AUDIENCE\_SEGMENTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience Topic
>
> **Slug:** `LETTR_GET_AUDIENCE_TOPIC`
>
> Retrieve one subscription topic's defaults, visibility, and current contact count.
>
> #### Input Parameters
>
> **topic\_id** `string` *required*
>
> Topic ID returned by CREATE\_AUDIENCE\_TOPIC or LIST\_AUDIENCE\_TOPICS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign
>
> **Slug:** `LETTR_GET_CAMPAIGN`
>
> 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.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> Campaign ID returned by LIST\_CAMPAIGNS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain
>
> **Slug:** `LETTR_GET_DOMAIN`
>
> Retrieve one sending domain's send readiness, DNS records, provider detection, and verification status.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Registered sending domain name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email
>
> **Slug:** `LETTR_GET_EMAIL`
>
> 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.
>
> #### Input Parameters
>
> **to\_date** `string`
>
> End of the event date range; defaults upstream to now.
>
> **from\_date** `string`
>
> Start of the event date range; defaults upstream to 10 days ago.
>
> **request\_id** `string` *required*
>
> Request ID returned by SEND\_EMAIL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Scheduled Email
>
> **Slug:** `LETTR_GET_SCHEDULED_EMAIL`
>
> Retrieve 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
>
> **transmission\_id** `string` *required*
>
> Transmission ID returned by SCHEDULE\_EMAIL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `LETTR_GET_TEMPLATE`
>
> Retrieve an email template's metadata, active HTML or editor JSON content, and version counts by slug.
>
> #### Input Parameters
>
> **project\_id** `integer`
>
> Project containing the template; defaults to the team's default project.
>
> **template\_slug** `string` *required*
>
> Template slug returned by CREATE\_TEMPLATE or LIST\_TEMPLATES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template Merge Tags
>
> **Slug:** `LETTR_GET_TEMPLATE_MERGE_TAGS`
>
> Return required and optional merge tags for a template's active or specified version before sending with substitution data.
>
> #### Input Parameters
>
> **version** `integer`
>
> Template version; defaults to the active version.
>
> **project\_id** `integer`
>
> Project containing the template; defaults to the team's default project.
>
> **template\_slug** `string` *required*
>
> Template slug whose variables should be inspected.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook
>
> **Slug:** `LETTR_GET_WEBHOOK`
>
> Retrieve one webhook's target, enabled state, event selection, authentication mode, and latest delivery status.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> Webhook ID returned by CREATE\_WEBHOOK or LIST\_WEBHOOKS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Audience Contacts
>
> **Slug:** `LETTR_LIST_AUDIENCE_CONTACTS`
>
> Return one cursor-controlled page of contacts, optionally filtered by search text, status, list, or segment.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **search** `string`
>
> Search text matched against the contact's email address or name.
>
> **status** `string ("subscribed" | "unsubscribed" | "bounced" | "complained" | "unverified")`
>
> Only return contacts with this subscription or delivery status.
>
> **list\_id** `string`
>
> Only return contacts attached to this team-owned audience list UUID.
>
> **per\_page** `integer`
>
> Maximum contacts to return in this page (1-100).
>
> **segment\_id** `string`
>
> Only return contacts matching this team-owned audience segment UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Audience Lists
>
> **Slug:** `LETTR_LIST_AUDIENCE_LISTS`
>
> Return one cursor-controlled page of audience lists with each list's contact count.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum audience lists to return in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Audience Properties
>
> **Slug:** `LETTR_LIST_AUDIENCE_PROPERTIES`
>
> Return one cursor-controlled page of custom contact-property definitions and fallback values.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum property definitions to return in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Audience Segments
>
> **Slug:** `LETTR_LIST_AUDIENCE_SEGMENTS`
>
> Return one cursor-controlled page of dynamic audience segments, including their complete AND-of-OR condition definitions, optionally filtered by list.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **list\_id** `string`
>
> Only return segments restricted to this team-owned audience list UUID.
>
> **per\_page** `integer`
>
> Maximum segments to return in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Audience Topics
>
> **Slug:** `LETTR_LIST_AUDIENCE_TOPICS`
>
> Return one cursor-controlled page of subscription topics with defaults, visibility, and contact counts.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum topics to return in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaign Events
>
> **Slug:** `LETTR_LIST_CAMPAIGN_EVENTS`
>
> Return 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
>
> **email** `string`
>
> Only return events for this recipient email address.
>
> **limit** `integer`
>
> Maximum campaign events to return in this page (1-100).
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **end\_date** `string`
>
> Inclusive ISO 8601 upper bound. A date-only value includes the entire UTC day.
>
> **event\_type** `string ("injection" | "delivery" | "bounce" | "spam_complaint" | "open" | "click" | "list_unsubscribe")`
>
> Only return events of this type.
>
> **start\_date** `string`
>
> Inclusive ISO 8601 lower bound. A date-only value means the start of that UTC day.
>
> **campaign\_id** `string` *required*
>
> Campaign whose events should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `LETTR_LIST_CAMPAIGNS`
>
> Return one cursor-controlled page of campaigns with complete delivery and engagement statistics, optionally filtered by lifecycle status.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **status** `string ("draft" | "scheduled" | "preparing" | "in_review" | "sending" | "sent" | "failed")`
>
> Only return campaigns in this lifecycle state.
>
> **per\_page** `integer`
>
> Maximum campaigns to return in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Domains
>
> **Slug:** `LETTR_LIST_DOMAINS`
>
> Return all sending domains with approval, DNS verification, and send-readiness status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Events
>
> **Slug:** `LETTR_LIST_EMAIL_EVENTS`
>
> Return 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
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **to\_date** `string`
>
> End of the ISO 8601 date range; defaults upstream to now.
>
> **per\_page** `integer`
>
> Maximum events to return in this page (1-100).
>
> **from\_date** `string`
>
> Start of the ISO 8601 date range; defaults upstream to 10 days ago.
>
> **recipients** `array`
>
> Recipient email addresses to include.
>
> **event\_types** `array`
>
> Event types to include.
>
> **bounce\_classes** `array`
>
> Bounce classification codes to include.
>
> **transmission\_id** `string`
>
> Only include events for this email request or transmission ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sent Emails
>
> **Slug:** `LETTR_LIST_EMAILS`
>
> Return 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
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **to\_date** `string`
>
> Include emails sent on or before this ISO 8601 date.
>
> **per\_page** `integer`
>
> Maximum sent-email records to return in this page (1-100).
>
> **from\_date** `string`
>
> Include emails sent on or after this ISO 8601 date; defaults upstream to 10 days ago.
>
> **recipient** `string`
>
> Only include emails sent to this recipient email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `LETTR_LIST_PROJECTS`
>
> Return one cursor-controlled page of Lettr projects and their IDs for use with template operations.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum projects to return in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `LETTR_LIST_TEMPLATES`
>
> Return one cursor-controlled page of email templates for a project or the team's default project.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pass the previous response's next\_cursor to fetch the next page; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum templates to return in this page (1-100).
>
> **project\_id** `integer`
>
> Project to list; defaults to the team's default project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `LETTR_LIST_WEBHOOKS`
>
> Return all event webhooks with target, enabled state, event selection, authentication mode, and latest delivery status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish Template Version
>
> **Slug:** `LETTR_PUBLISH_TEMPLATE_VERSION`
>
> Create 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
>
> **html** `string`
>
> HTML content for the new active version; provide exactly one content format.
>
> **name** `string`
>
> Optional new template name applied atomically with the published version.
>
> **project\_id** `integer`
>
> Project containing the template; defaults to the team's default project.
>
> **editor\_json** `string`
>
> Topol editor JSON for the new active version; provide exactly one content format.
>
> **template\_slug** `string` *required*
>
> Template slug to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Schedule Campaign
>
> **Slug:** `LETTR_SCHEDULE_CAMPAIGN`
>
> Schedule a campaign for future delivery or reschedule it. The campaign dispatches automatically at that time unless it is unscheduled first.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> Campaign ID to schedule or reschedule.
>
> **scheduled\_at** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Schedule Email
>
> **Slug:** `LETTR_SCHEDULE_EMAIL`
>
> Schedule 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
>
> **cc** `array`
>
> Carbon-copy recipient email addresses.
>
> **to** `array` *required*
>
> Recipient email addresses, up to 50.
>
> **bcc** `array`
>
> Blind-carbon-copy recipient email addresses.
>
> **tag** `string`
>
> Tracking and analytics tag.
>
> **html** `string`
>
> HTML body; provide html, text, or template\_slug.
>
> **text** `string`
>
> Plain-text body; provide html, text, or template\_slug.
>
> **headers** `object`
>
> Up to 10 custom email headers. Envelope, Lettr-managed, X-MSYS-API, List-Unsubscribe, and List-Unsubscribe-Post headers are forbidden.
>
> **options** `object`
>
> Email tracking, rendering, and delivery options.
>
> **subject** `string`
>
> Subject line; required unless template\_slug is provided.
>
> **amp\_html** `string`
>
> Optional AMP HTML body.
>
> **metadata** `object`
>
> Custom string metadata for tracking.
>
> **reply\_to** `string`
>
> Reply-to email address.
>
> **from\_name** `string`
>
> Sender display name.
>
> **from\_email** `string` *required*
>
> Verified sender email address.
>
> **project\_id** `integer`
>
> Project containing template\_slug; defaults to the team's default project.
>
> **attachments** `array`
>
> File attachments with filename, MIME type, and base64 data.
>
> **scheduled\_at** `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.
>
> **reply\_to\_name** `string`
>
> Reply-to display name.
>
> **template\_slug** `string`
>
> Template whose active HTML and default subject should be used.
>
> **template\_version** `integer`
>
> Specific template version; defaults to the active version.
>
> **substitution\_data** `object`
>
> Values for template substitution in email content.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Campaign
>
> **Slug:** `LETTR_SEND_CAMPAIGN`
>
> Immediately 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
>
> **campaign\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Email
>
> **Slug:** `LETTR_SEND_EMAIL`
>
> Immediately queue a transactional email to up to 50 recipients using inline content or a Lettr template. This is an irreversible external send.
>
> #### Input Parameters
>
> **cc** `array`
>
> Carbon-copy recipient email addresses.
>
> **to** `array` *required*
>
> Recipient email addresses, up to 50.
>
> **bcc** `array`
>
> Blind-carbon-copy recipient email addresses.
>
> **tag** `string`
>
> Tracking tag, up to 64 characters.
>
> **html** `string`
>
> HTML body; provide html, text, or template\_slug.
>
> **text** `string`
>
> Plain-text body; provide html, text, or template\_slug.
>
> **headers** `object`
>
> Up to 10 custom email headers. Envelope headers and Lettr-managed headers cannot be set.
>
> **options** `object`
>
> Tracking, transactional, CSS, and substitution options.
>
> **subject** `string`
>
> Subject line; required unless template\_slug supplies one.
>
> **amp\_html** `string`
>
> Optional AMP HTML body.
>
> **metadata** `object`
>
> Custom string metadata for tracking.
>
> **reply\_to** `string`
>
> Reply-to email address.
>
> **from\_name** `string`
>
> Sender display name.
>
> **from\_email** `string` *required*
>
> Verified sender email address.
>
> **project\_id** `integer`
>
> Project containing template\_slug; defaults to the team's default project.
>
> **attachments** `array`
>
> Attachments containing a filename, MIME type, and base64 data.
>
> **reply\_to\_name** `string`
>
> Reply-to display name.
>
> **template\_slug** `string`
>
> Template whose active HTML and default subject should be used.
>
> **template\_version** `integer`
>
> Specific template version; defaults to the active version.
>
> **substitution\_data** `object`
>
> Values for template merge tags.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unschedule Campaign
>
> **Slug:** `LETTR_UNSCHEDULE_CAMPAIGN`
>
> Cancel 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
>
> **campaign\_id** `string` *required*
>
> Currently scheduled campaign ID to return to draft.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Audience Contact
>
> **Slug:** `LETTR_UPDATE_AUDIENCE_CONTACT`
>
> 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.
>
> #### Input Parameters
>
> **email** `string`
>
> New email address, which must remain unique within the team.
>
> **status** `string ("subscribed" | "unsubscribed")`
>
> New subscription status. Bounced, complained, and unverified cannot be assigned with this action.
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> **properties** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Audience List
>
> **Slug:** `LETTR_UPDATE_AUDIENCE_LIST`
>
> Rename an audience list while preserving its contacts.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New list name, which must remain unique within the team.
>
> **list\_id** `string` *required*
>
> Audience list ID to rename.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Audience Property
>
> **Slug:** `LETTR_UPDATE_AUDIENCE_PROPERTY`
>
> Set or clear a custom contact property's fallback value. Its name and data type cannot be changed.
>
> #### Input Parameters
>
> **property\_id** `string` *required*
>
> Property ID to update.
>
> **fallback\_value** `string` *required*
>
> New fallback value, or null to clear the fallback.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Audience Segment
>
> **Slug:** `LETTR_UPDATE_AUDIENCE_SEGMENT`
>
> 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.
>
> #### Input Parameters
>
> **name** `string`
>
> New segment name.
>
> **list\_id** `string`
>
> New team-owned list restriction, or null to evaluate contacts across all lists.
>
> **conditions** `object`
>
> Complete replacement condition definition.
>
> **segment\_id** `string` *required*
>
> Segment ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Audience Topic
>
> **Slug:** `LETTR_UPDATE_AUDIENCE_TOPIC`
>
> Change 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
>
> **name** `string`
>
> New topic name.
>
> **topic\_id** `string` *required*
>
> Topic ID to update.
>
> **visibility** `string ("private" | "public")`
>
> Whether the topic appears on public subscription pages.
>
> **description** `string`
>
> New topic description; explicitly set this to null to clear it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Template
>
> **Slug:** `LETTR_UPDATE_TEMPLATE`
>
> Rename an email template's metadata without publishing a new version.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New template name.
>
> **project\_id** `integer`
>
> Project containing the template; defaults to the team's default project.
>
> **template\_slug** `string` *required*
>
> Template slug to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `LETTR_UPDATE_WEBHOOK`
>
> Partially 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
>
> **url** `string`
>
> New public HTTPS callback URL.
>
> **name** `string`
>
> New webhook name.
>
> **active** `boolean`
>
> Whether Lettr should deliver events to this webhook.
>
> **events** `array`
>
> Replacement list of canonical fully-prefixed event names.
>
> **auth\_type** `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.
>
> **webhook\_id** `string` *required*
>
> Webhook ID to update.
>
> **auth\_password** `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.
>
> **auth\_username** `string`
>
> Replacement Basic-auth username; required when auth\_type is basic. Without auth\_type, rotates credentials for an existing Basic webhook.
>
> **oauth\_client\_id** `string`
>
> Replacement OAuth 2 client ID; required when auth\_type is oauth2. Without auth\_type, rotates credentials for an existing OAuth 2 webhook.
>
> **oauth\_token\_url** `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.
>
> **oauth\_client\_secret** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Domain
>
> **Slug:** `LETTR_VERIFY_DOMAIN`
>
> Run Lettr's DNS verification for a registered domain and return DKIM, CNAME, DMARC, SPF, and ownership results.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Registered domain whose current DNS records should be checked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
