---
canonical_url: "https://docs.composio.dev/toolkits/lettr"
markdown_url: "https://docs.composio.dev/toolkits/lettr.md"
product: "platform"
version: null
last_updated: null
---

# Lettr

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | array | Yes | IDs of 1-50 team-owned audience lists. Every contact in contact_ids is attached to every list. |
| `contact_ids` | array | Yes | IDs of 1-1000 team-owned contacts to attach. Every contact is attached to every list in list_ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Create Audience Contacts

**Slug:** `LETTR_BULK_CREATE_AUDIENCE_CONTACTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Email addresses to normalize, deduplicate, and create (1-1000). |
| `list_id` | string | No | Optional team-owned audience list UUID to attach every contact to. |
| `properties` | object | No | Custom property values applied identically only to newly created contacts; existing contacts are not updated. Each value is at most 1000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transmission_id` | string | Yes | Transmission ID returned by SCHEDULE_EMAIL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Audience Contact

**Slug:** `LETTR_CREATE_AUDIENCE_CONTACT`

Create one audience contact with optional properties and list membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Contact email address. |
| `list_id` | string | No | Optional team-owned audience list UUID to attach the new contact to. |
| `properties` | object | No | Custom values keyed by property names already defined for the team; each value is at most 1000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Audience List

**Slug:** `LETTR_CREATE_AUDIENCE_LIST`

Create a uniquely named audience list for grouping contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | List name, which must be unique within the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 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") | Yes | Immutable value type. The optional fallback_value remains a string and is interpreted according to this type. |
| `fallback_value` | string | No | Optional fallback string interpreted according to property_type, or null for no fallback. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Segment name. |
| `list_id` | string | No | Optional team-owned audience list restriction. Omit or pass null to evaluate contacts across all lists. |
| `conditions` | object | Yes | Dynamic segment definition using ANDed groups of ORed conditions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Topic name. |
| `visibility` | string ("private" | "public") | No | Whether the topic appears on public subscription pages. |
| `description` | string | No | Optional explanation shown for the topic. |
| `default_subscription` | string ("opt_in" | "opt_out") | No | Immutable default for newly created contacts: opt_in requires explicit subscription; opt_out subscribes contacts by default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Domain

**Slug:** `LETTR_CREATE_DOMAIN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Root or subdomain to register as a sending domain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template

**Slug:** `LETTR_CREATE_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | Custom HTML content; provide exactly one of html or editor_json. |
| `name` | string | Yes | Template name. |
| `folder_id` | integer | No | Destination folder; defaults to the project's first folder. |
| `project_id` | integer | No | Destination project; defaults to the team's default project. |
| `editor_json` | string | No | Topol editor JSON string; provide exactly one of editor_json or html. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `LETTR_CREATE_WEBHOOK`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Audience Contact

**Slug:** `LETTR_DELETE_AUDIENCE_CONTACT`

Permanently delete one audience contact and its associated memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Audience Lists

**Slug:** `LETTR_DELETE_AUDIENCE_LISTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | array | Yes | IDs of 1-50 audience lists to permanently delete; every list must belong to the connected team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Audience Property

**Slug:** `LETTR_DELETE_AUDIENCE_PROPERTY`

Permanently delete a custom contact-property definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `property_id` | string | Yes | Property ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Audience Segment

**Slug:** `LETTR_DELETE_AUDIENCE_SEGMENT`

Permanently delete one dynamic audience segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Segment ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Audience Topic

**Slug:** `LETTR_DELETE_AUDIENCE_TOPIC`

Permanently delete one audience subscription topic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic_id` | string | Yes | Topic ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Domain

**Slug:** `LETTR_DELETE_DOMAIN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Registered domain to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Template

**Slug:** `LETTR_DELETE_TEMPLATE`

Permanently delete an email template and all of its versions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | No | Project containing the template; defaults to the team's default project. |
| `template_slug` | string | Yes | Template slug to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `LETTR_DELETE_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | array | Yes | IDs of 1-50 team-owned audience lists. Every contact in contact_ids is detached from every list. |
| `contact_ids` | array | Yes | IDs of 1-1000 team-owned contacts to detach. Every contact is detached from every list in list_ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID returned by CREATE_AUDIENCE_CONTACT or LIST_AUDIENCE_CONTACTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Audience List

**Slug:** `LETTR_GET_AUDIENCE_LIST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | Audience list ID returned by CREATE_AUDIENCE_LIST or LIST_AUDIENCE_LISTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Audience Property

**Slug:** `LETTR_GET_AUDIENCE_PROPERTY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `property_id` | string | Yes | Property ID returned by CREATE_AUDIENCE_PROPERTY or LIST_AUDIENCE_PROPERTIES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Segment ID returned by CREATE_AUDIENCE_SEGMENT or LIST_AUDIENCE_SEGMENTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Audience Topic

**Slug:** `LETTR_GET_AUDIENCE_TOPIC`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic_id` | string | Yes | Topic ID returned by CREATE_AUDIENCE_TOPIC or LIST_AUDIENCE_TOPICS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | Campaign ID returned by LIST_CAMPAIGNS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Domain

**Slug:** `LETTR_GET_DOMAIN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Registered sending domain name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End of the event date range; defaults upstream to now. |
| `from_date` | string | No | Start of the event date range; defaults upstream to 10 days ago. |
| `request_id` | string | Yes | Request ID returned by SEND_EMAIL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scheduled Email

**Slug:** `LETTR_GET_SCHEDULED_EMAIL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transmission_id` | string | Yes | Transmission ID returned by SCHEDULE_EMAIL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | No | Project containing the template; defaults to the team's default project. |
| `template_slug` | string | Yes | Template slug returned by CREATE_TEMPLATE or LIST_TEMPLATES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | integer | No | Template version; defaults to the active version. |
| `project_id` | integer | No | Project containing the template; defaults to the team's default project. |
| `template_slug` | string | Yes | Template slug whose variables should be inspected. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `LETTR_GET_WEBHOOK`

Retrieve one webhook's target, enabled state, event selection, authentication mode, and latest delivery status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook ID returned by CREATE_WEBHOOK or LIST_WEBHOOKS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audience Lists

**Slug:** `LETTR_LIST_AUDIENCE_LISTS`

Return one cursor-controlled page of audience lists with each list's contact count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `per_page` | integer | No | Maximum audience lists to return in this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audience Properties

**Slug:** `LETTR_LIST_AUDIENCE_PROPERTIES`

Return one cursor-controlled page of custom contact-property definitions and fallback values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `per_page` | integer | No | Maximum property definitions to return in this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `list_id` | string | No | Only return segments restricted to this team-owned audience list UUID. |
| `per_page` | integer | No | Maximum segments to return in this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audience Topics

**Slug:** `LETTR_LIST_AUDIENCE_TOPICS`

Return one cursor-controlled page of subscription topics with defaults, visibility, and contact counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `per_page` | integer | No | Maximum topics to return in this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Only return events for this recipient email address. |
| `limit` | integer | No | Maximum campaign events to return in this page (1-100). |
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `end_date` | string | No | 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") | No | Only return events of this type. |
| `start_date` | string | No | Inclusive ISO 8601 lower bound. A date-only value means the start of that UTC day. |
| `campaign_id` | string | Yes | Campaign whose events should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | 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") | No | Only return campaigns in this lifecycle state. |
| `per_page` | integer | No | Maximum campaigns to return in this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Domains

**Slug:** `LETTR_LIST_DOMAINS`

Return all sending domains with approval, DNS verification, and send-readiness status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `to_date` | string | No | End of the ISO 8601 date range; defaults upstream to now. |
| `per_page` | integer | No | Maximum events to return in this page (1-100). |
| `from_date` | string | No | Start of the ISO 8601 date range; defaults upstream to 10 days ago. |
| `recipients` | array | No | Recipient email addresses to include. |
| `event_types` | array | No | Event types to include. |
| `bounce_classes` | array | No | Bounce classification codes to include. |
| `transmission_id` | string | No | Only include events for this email request or transmission ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sent Emails

**Slug:** `LETTR_LIST_EMAILS`

Return one cursor-controlled page of sent emails, optionally filtered by recipient and date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `to_date` | string | No | Include emails sent on or before this ISO 8601 date. |
| `per_page` | integer | No | Maximum sent-email records to return in this page (1-100). |
| `from_date` | string | No | Include emails sent on or after this ISO 8601 date; defaults upstream to 10 days ago. |
| `recipient` | string | No | Only include emails sent to this recipient email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `LETTR_LIST_PROJECTS`

Return one cursor-controlled page of Lettr projects and their IDs for use with template operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `per_page` | integer | No | Maximum projects to return in this page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pass the previous response's next_cursor to fetch the next page; omit for the first page. |
| `per_page` | integer | No | Maximum templates to return in this page (1-100). |
| `project_id` | integer | No | Project to list; defaults to the team's default project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `LETTR_LIST_WEBHOOKS`

Return all event webhooks with target, enabled state, event selection, authentication mode, and latest delivery status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish Template Version

**Slug:** `LETTR_PUBLISH_TEMPLATE_VERSION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | HTML content for the new active version; provide exactly one content format. |
| `name` | string | No | Optional new template name applied atomically with the published version. |
| `project_id` | integer | No | Project containing the template; defaults to the team's default project. |
| `editor_json` | string | No | Topol editor JSON for the new active version; provide exactly one content format. |
| `template_slug` | string | Yes | Template slug to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | Campaign ID to schedule or reschedule. |
| `scheduled_at` | string | Yes | Future delivery time in ISO 8601 format. Include a timezone offset or Z; Lettr interprets a value without an offset as UTC. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule Email

**Slug:** `LETTR_SCHEDULE_EMAIL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | Carbon-copy recipient email addresses. |
| `to` | array | Yes | Recipient email addresses, up to 50. |
| `bcc` | array | No | Blind-carbon-copy recipient email addresses. |
| `tag` | string | No | Tracking and analytics tag. |
| `html` | string | No | HTML body; provide html, text, or template_slug. |
| `text` | string | No | Plain-text body; provide html, text, or template_slug. |
| `headers` | object | No | Up to 10 custom email headers. Envelope, Lettr-managed, X-MSYS-API, List-Unsubscribe, and List-Unsubscribe-Post headers are forbidden. |
| `options` | object | No | Email tracking, rendering, and delivery options. |
| `subject` | string | No | Subject line; required unless template_slug is provided. |
| `amp_html` | string | No | Optional AMP HTML body. |
| `metadata` | object | No | Custom string metadata for tracking. |
| `reply_to` | string | No | Reply-to email address. |
| `from_name` | string | No | Sender display name. |
| `from_email` | string | Yes | Verified sender email address. |
| `project_id` | integer | No | Project containing template_slug; defaults to the team's default project. |
| `attachments` | array | No | File attachments with filename, MIME type, and base64 data. |
| `scheduled_at` | string | Yes | 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 | No | Reply-to display name. |
| `template_slug` | string | No | Template whose active HTML and default subject should be used. |
| `template_version` | integer | No | Specific template version; defaults to the active version. |
| `substitution_data` | object | No | Values for template substitution in email content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unschedule Campaign

**Slug:** `LETTR_UNSCHEDULE_CAMPAIGN`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | Currently scheduled campaign ID to return to draft. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | New email address, which must remain unique within the team. |
| `status` | string ("subscribed" | "unsubscribed") | No | New subscription status. Bounced, complained, and unverified cannot be assigned with this action. |
| `contact_id` | string | Yes | Contact ID to update. |
| `properties` | object | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Audience List

**Slug:** `LETTR_UPDATE_AUDIENCE_LIST`

Rename an audience list while preserving its contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New list name, which must remain unique within the team. |
| `list_id` | string | Yes | Audience list ID to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `property_id` | string | Yes | Property ID to update. |
| `fallback_value` | string | Yes | New fallback value, or null to clear the fallback. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New segment name. |
| `list_id` | string | No | New team-owned list restriction, or null to evaluate contacts across all lists. |
| `conditions` | object | No | Complete replacement condition definition. |
| `segment_id` | string | Yes | Segment ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New topic name. |
| `topic_id` | string | Yes | Topic ID to update. |
| `visibility` | string ("private" | "public") | No | Whether the topic appears on public subscription pages. |
| `description` | string | No | New topic description; explicitly set this to null to clear it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template

**Slug:** `LETTR_UPDATE_TEMPLATE`

Rename an email template's metadata without publishing a new version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New template name. |
| `project_id` | integer | No | Project containing the template; defaults to the team's default project. |
| `template_slug` | string | Yes | Template slug to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `LETTR_UPDATE_WEBHOOK`

Partially update a webhook's name, callback URL, authentication, selected events, or active state. Provide at least one field to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | New public HTTPS callback URL. |
| `name` | string | No | New webhook name. |
| `active` | boolean | No | Whether Lettr should deliver events to this webhook. |
| `events` | array | No | Replacement list of canonical fully-prefixed event names. |
| `auth_type` | string ("none" | "basic" | "oauth2") | No | 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 | Yes | Webhook ID to update. |
| `auth_password` | string | No | 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 | No | Replacement Basic-auth username; required when auth_type is basic. Without auth_type, rotates credentials for an existing Basic webhook. |
| `oauth_client_id` | string | No | 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 | No | 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 | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Registered domain whose current DNS records should be checked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |