API_KEY
lettr_api_key
Developer setup
No fields declared in this snapshot.
User connection
- API Keygeneric_api_key · stringRequired
All integrations
LE
Catalogue metadata onlytransactional emailv00000000_00
LETTR
Lettr
Lettr is an email and messaging platform for transactional delivery, templates, audiences, campaigns, domains, and webhooks.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source 60
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
What setup is declared?
Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
API_KEY
Provider setup
Capability index
Actions and trigger definitions
Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.
Showing 31–60 of 60 actions
Get Template
LETTR_GET_TEMPLATE
Retrieve an email template's metadata, active HTML or editor JSON content, and version counts by slug.
Untrusted display-only summary
Get Template Merge Tags
LETTR_GET_TEMPLATE_MERGE_TAGS
Return required and optional merge tags for a template's active or specified version before sending with substitution data.
Untrusted display-only summary
Get Webhook
LETTR_GET_WEBHOOK
Retrieve one webhook's target, enabled state, event selection, authentication mode, and latest delivery status.
Untrusted display-only summary
List Audience Contacts
LETTR_LIST_AUDIENCE_CONTACTS
Return one cursor-controlled page of contacts, optionally filtered by search text, status, list, or segment.
Untrusted display-only summary
List Audience Lists
LETTR_LIST_AUDIENCE_LISTS
Return one cursor-controlled page of audience lists with each list's contact count.
Untrusted display-only summary
List Audience Properties
LETTR_LIST_AUDIENCE_PROPERTIES
Return one cursor-controlled page of custom contact-property definitions and fallback values.
Untrusted display-only summary
List Audience Segments
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.
Untrusted display-only summary
List Audience Topics
LETTR_LIST_AUDIENCE_TOPICS
Return one cursor-controlled page of subscription topics with defaults, visibility, and contact counts.
Untrusted display-only summary
List Campaign Events
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.
Untrusted display-only summary
List Campaigns
LETTR_LIST_CAMPAIGNS
Return one cursor-controlled page of campaigns with complete delivery and engagement statistics, optionally filtered by lifecycle status.
Untrusted display-only summary
List Domains
LETTR_LIST_DOMAINS
Return all sending domains with approval, DNS verification, and send-readiness status.
Untrusted display-only summary
List Email Events
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.
Untrusted display-only summary
List Sent Emails
LETTR_LIST_EMAILS
Return one cursor-controlled page of sent emails, optionally filtered by recipient and date range.
Untrusted display-only summary
List Projects
LETTR_LIST_PROJECTS
Return one cursor-controlled page of Lettr projects and their IDs for use with template operations.
Untrusted display-only summary
List Templates
LETTR_LIST_TEMPLATES
Return one cursor-controlled page of email templates for a project or the team's default project.
Untrusted display-only summary
List Webhooks
LETTR_LIST_WEBHOOKS
Return all event webhooks with target, enabled state, event selection, authentication mode, and latest delivery status.
Untrusted display-only summary
Publish Template Version
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.
Untrusted display-only summary
Schedule Campaign
LETTR_SCHEDULE_CAMPAIGN
Schedule a campaign for future delivery or reschedule it. The campaign dispatches automatically at that time unless it is unscheduled first.
Untrusted display-only summary
Schedule Email
LETTR_SCHEDULE_EMAIL
Create a transactional email scheduled 5 minutes to 3 days in the future; it remains cancellable until processed.
Untrusted display-only summary
Send Campaign
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.
Untrusted display-only summary
Send Email
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.
Untrusted display-only summary
Unschedule Campaign
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.
Untrusted display-only summary
Update Audience Contact
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.
Untrusted display-only summary
Update Audience List
LETTR_UPDATE_AUDIENCE_LIST
Rename an audience list while preserving its contacts.
Untrusted display-only summary
Update Audience Property
LETTR_UPDATE_AUDIENCE_PROPERTY
Set or clear a custom contact property's fallback value. Its name and data type cannot be changed.
Untrusted display-only summary
Update Audience Segment
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.
Untrusted display-only summary
Update Audience Topic
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.
Untrusted display-only summary
Update Template
LETTR_UPDATE_TEMPLATE
Rename an email template's metadata without publishing a new version.
Untrusted display-only summary
Update Webhook
LETTR_UPDATE_WEBHOOK
Partially update a webhook's name, callback URL, authentication, selected events, or active state. Provide at least one field to update.
Untrusted display-only summary
Verify Domain
LETTR_VERIFY_DOMAIN
Run Lettr's DNS verification for a registered domain and return DKIM, CNAME, DMARC, SPF, and ownership results.
Untrusted display-only summary
Provenance
Versioned facts, explicit trust.
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
- Repository
- https://github.com/provider-directoryHQ/provider-directory
- Commit
- 85e33f6a81dfe987f6fc3637d48d45052cea8ca5
- Generated
- 2026-09-12
- Trust policy
- untrusted_display_only
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.