Lettermint Team API
​string · required​string · required​DkimMode · enum · required​boolean · required​string | null · date-time · required​string · date-time · required​string · required​RecordType · enum · required​string · required​string · required​string · required​DnsRecordStatus · enum · required
​DnsRecordPurpose · enum · required​DnsVerificationScope · enum · required​boolean · required​string | null · required​string | null · date-time · required​string · required​string · required​DomainStatus · enum · required
​DkimMode · enum · required​string | null · date-time · required​string · date-time · required​integer · required​string · required​string | null · required​string · required​string · required​MessageType · enum · required​MessageStatus · enum · required​string | null · date-time · required​string | null · date-time · required​string | null · required​string · required​string | null · required​array | null · required​string | null · required​string · required​string · date-time · required​number | null​string · required​MessageEventType · enum · required​string | null · required​string · date-time · required​string · required​MessageType · enum · required​MessageStatus · enum · required​string | null · date-time · required​string · required​string | null · required​string | null · required​array | null · required​string | null · required​string | null · required​string · required​number | null​integer · required​integer · required​integer · required​number · required​string · required​string · required​boolean · required​boolean · required​string | null · required​string | null · date-time · required​string | null · date-time · required​string | null · required​string · required​string · required​string · required​string · required​boolean · required​integer · required​integer · required​string · required​string · required​string · required​string · required​string · required​string · required​RouteType · enum · required​boolean · required​string · date-time · required​string · date-time · required​string | null​string | null​string | null · date-time​number | null​AttachmentDelivery · enum​object | null​integer​integer​string · required​string · required​string · required​RouteType · enum · required​boolean · required​integer · required​integer · required​string · date-time · required​string · date-time · required​string · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer | null · required​integer | null · required​integer | null · required​integer | null​integer | null​integer | null​string · required​number · required​string[] · minItems: 1 · required​string | null · required​string · required​integer · required​integer · required​integer · required​integer · required​integer | null · required​integer | null · required​integer | null · required​integer | null · required​integer | null · required​integer | null​integer | null​integer | null​string · required​string · required​string · date · required​string · date · required​string | null · uuid​boolean​integer · required​integer · required​integer · required​integer · required​integer | null · required​integer | null · required​integer | null · required​integer | null · required​integer | null · required​integer | null​integer | null​integer | null​integer · required​integer · required​integer · required​string · maxLength: 255 · pattern: ​string · maxLength: 255 · required​boolean​InitialRoutes · enum​boolean​string · maxLength: 255 · required​RouteType · enum · required​string | null · maxLength: 255​SuppressionReason · enum · required​SuppressionScope · enum · required​string | null · email · maxLength: 255​array | null · minItems: 1 · maxItems: 1000​string | null · uuid​string | null · uuid​string · maxLength: 255 · required​string · uri · maxLength: 500 · required​WebhookEvent[] · minItems: 1 · required​boolean | null​boolean | null​string[] · maxItems: 1000 · unique​string[] · maxItems: 1000 · unique​string | null · uuid​string · required​SuppressionType · enum · required​string · required​SuppressionReason · enum · required​SuppressionScope · enum · required​SuppressionAppliesTo · enum · required​string | null · required​string | null · required​string · date-time · required​string · required​boolean · required​string | null · required​string | null · date-time · required​string · required​string · required​TeamType · enum · required​Plan · enum · required​integer · required​string | null · date-time · required​string · date-time · required​string[]​integer​integer​integer​integer · deprecated​string · required​string · required​string · required​string | null · date-time · required​ProjectAccessScope · enum · required​string · required​string · required​RbacPermission[] · required​boolean · required​integer · required​string | null · date-time · required​string · date-time · required​string · date-time · required​string | null · maxLength: 255​boolean | null​boolean | null​string | null · uuid​string | null · maxLength: 255​number | null · min: 0 · max: 10​boolean | null​boolean | null​boolean | null​boolean | null​boolean | null​boolean | null​boolean | null​string · maxLength: 255​string · uri · maxLength: 500​WebhookEvent[] · minItems: 1​boolean​boolean​WebhookScope · enum​string[] · maxItems: 1000 · unique​string[] · maxItems: 1000 · unique​string | null · uuid​string · required​WebhookScope · enum · required​string[] · required​string[] · required​string · required​string · required​string[] · required​boolean · required​boolean · required​string | null · date-time · required​string · date-time · required​string · date-time · required​string | null · deprecated​string · required​string · required​WebhookEvent · enum · required​string | null · required​string | null · required​string | null · required​WebhookDeliveryStatus · enum · required​integer · required​integer | null · required​integer | null · required​string[] · minItems: 1 · required​string | null · required​array | null · required​string | null · required​string | null · date-time · required​string · date-time · required​string · required​string · required​WebhookEvent · enum · required​string | null · required​string | null · required​string | null · required​WebhookDeliveryStatus · enum · required​integer · required​integer | null · required​integer | null · required​string | null · date-time · required​string · date-time · required​string · required​WebhookScope · enum · required​string[] · required​string[] · required​string · required​string · required​string[] · required​boolean · required​string | null · date-time · required​string · date-time · required​string · date-time · required​string | null · deprecated​string · required​WebhookScope · enum · required​string[] · required​string[] · required​string · required​string · required​string[] · required​boolean · required​boolean · required​string · required​string | null · date-time · required​string · date-time · required​string · date-time · required​string | null · deprecated
Schemas
DnsRecordStatus
string · enum
Enum values:
active
failed
pending
active The record is active and verified. |
failed The record could not be verified. |
pending The record is pending verification. |
DomainData
iddomaindkim_modeEnum values:
legacy_txt
managed_cname
rotation_readystatus_changed_atcreated_at​object[]
DomainDnsRecordData
idtypeEnum values:
TXT
CNAME
MX
hostnamefqdncontentstatusactive The record is active and verified. |
failed The record could not be verified. |
pending The record is pending verification. |
Enum values:
active
failed
pending
purposeEnum values:
return_path
dmarc
dkim_legacy
dkim_primary
dkim_secondary
verification_scopeEnum values:
required
recommended
migration
deprecated
required_for_verificationverified_atlast_checked_atDomainListData
iddomainstatusverified The domain is active and verified. |
partially_verified Some DNS records of the domain could not be verified. |
pending_verification The domain is new and verification is pending. |
failed_verification The domain verification failed. |
Enum values:
verified
partially_verified
pending_verification
failed_verification
dkim_modeEnum values:
legacy_txt
managed_cname
status_changed_atcreated_atDomainStatus
string · enum
Enum values:
verified
partially_verified
pending_verification
failed_verification
verified The domain is active and verified. |
partially_verified Some DNS records of the domain could not be verified. |
pending_verification The domain is new and verification is pending. |
failed_verification The domain verification failed. |
MessageAttachmentData
sizeDefault: 0
filenameDefault: unknown
content_idcontent_typeDefault: application/octet-stream
MessageData
idtypeEnum values:
inbound
outbound
statusEnum values:
scheduled
pending
queued
quarantined
suppressed
processed
delivered
opened
status_changed_atscheduled_attag​object[] · required
from_emailfrom_namereply_tosubject​array | null · required
​array | null · required
​array | null · required
​array | null · required
​object | null · required
route_idcreated_atspam_scoreOverall spam assessment score. Scores below 5 are clean, 5 through 10 indicate potential spam, scores above 10 and below 15 are likely spam, and 15 or higher is definite spam. Null means no assessment is available. Available on plans with Spam Insights
​SpamSymbol[]
Detailed rules that contributed to the spam assessment. Available on plans with Spam Insights in individual-message responses
MessageEventData
message_ideventEnum values:
scheduled
rescheduled
canceled
released
queued
processed
suppressed
delivered
tag​object[] · required
​object | null · required
timestampMessageEventType
string · enum
Enum values:
scheduled
rescheduled
canceled
released
queued
processed
suppressed
delivered
MessageListData
idtypeEnum values:
inbound
outbound
statusEnum values:
scheduled
pending
queued
quarantined
suppressed
processed
delivered
opened
scheduled_atfrom_emailfrom_namesubject​array | null · required
​array | null · required
​array | null · required
reply_totag​object[] · required
status_changed_atcreated_atspam_scoreOverall spam assessment score. Scores below 5 are clean, 5 through 10 indicate potential spam, scores above 10 and below 15 are likely spam, and 15 or higher is definite spam. Null means no assessment is available. Available on plans with Spam Insights
MessageStatsData
messages_transactionalmessages_broadcastmessages_inbounddeliverabilityMessageStatus
string · enum
Enum values:
scheduled
pending
queued
quarantined
suppressed
processed
delivered
opened
ProjectData
idnamesmtp_enabledredact_email_contentdefault_route_idtoken_generated_attoken_last_used_attoken_last_used_ipcreated_atupdated_atProjectListData
idnamesmtp_enabledroutes_countdomains_count​MessageStatsData · required
created_atupdated_atRbacConflictCode
string · enum
Enum values:
stale_resource
owner_protected
last_owner
built_in_role_immutable
custom_role_requires_pro
RbacPermission
string · enum
Enum values:
team:manage
billing:manage
security:manage
audit:read
support:manage
members:read
members:manage
roles:manage
RouteData
idproject_idslugnameroute_typeEnum values:
transactional
broadcast
inbound
is_defaultcreated_atupdated_atinbound_addressinbound_domaininbound_domain_verified_atinbound_spam_thresholdattachment_deliveryEnum values:
inline
url
settingsRoute settings available for this route type and team feature access
​ProjectData
webhooks_countsuppressed_recipients_countRouteListData
idslugnameroute_typeEnum values:
transactional
broadcast
inbound
is_defaultwebhooks_countsuppressed_recipients_countcreated_atupdated_atRouteStatisticData
datesent_countdelivered_countopened_countclicked_counthard_bounce_countspam_complaint_countinbound_received_counteffective_opened_countmachine_opened_countmachine_clicked_countobserved_opened_counthuman_opened_countprivacy_opened_countSpamSymbol
namescoreoptionsDefault: []
descriptionStatsDailyData
datesentdeliveredhard_bouncedspam_complaintsopenedNull when tracking is not enabled for this context
clickedNull when tracking is not enabled for this context
​StatsInboundData · required
​required
​required
effective_openedmachine_openedmachine_clickedobserved_openedHuman opens plus unresolved privacy-proxy opens
human_openedprivacy_openedStatsData
fromto​StatsTotalsData · required
​StatsDailyData[] · required
StatsRequestData
fromStart date (Y-m-d)
toEnd date (Y-m-d, maximum 90 days from from)
project_idOptional project UUID for project-scoped statistics with transactional and broadcast breakdowns
include_machineInclude legacy machine observations in open and click totals. Privacy opens are reported in the observed and privacy fields without this option
Default: false
StatsTotalsData
sentdeliveredhard_bouncedspam_complaintsopenedNull when tracking is not enabled for this context
clickedNull when tracking is not enabled for this context
​StatsInboundData · required
​required
​required
effective_openedmachine_openedmachine_clickedobserved_openedHuman opens plus unresolved privacy-proxy opens
human_openedprivacy_openedStatsTypeData
senthard_bouncedspam_complaintsStoreDomainData
domain^(?!:\/\/)(?=.{1,255… · requiredStoreProjectData
namesmtp_enabledDefault: false
initial_routesEnum values:
both
transactional
broadcast
Default: both
short_tokenDefault: false
StoreRouteData
nameroute_typeEnum values:
transactional
broadcast
inbound
slugStoreSuppressionData
reasonReason that the recipient is suppressed.
Enum values:
spam_complaint
hard_bounce
unsubscribe
manual
scopeWhere the suppression applies.
Enum values:
team
project
route
emailemailsroute_idproject_id​
Mail category to block. Manual suppressions default to all. Use broadcast only at team scope, project scope, or on a broadcast route.
StoreWebhookData
nameurleventsEnum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
enabledDefault: true
include_machine_eventsDefault: false
​
project_idsDefault: []
route_idsDefault: []
route_idSuppressedRecipientData
idtypeEnum values:
email
domain
extension
valuereasonReason that the recipient is suppressed.
Enum values:
spam_complaint
hard_bounce
unsubscribe
manual
scopeWhere the suppression applies.
Enum values:
team
project
route
applies_toMail category blocked by the suppression. all blocks transactional and broadcast mail. broadcast blocks broadcast mail only.
Enum values:
all
broadcast
project_idroute_idcreated_at​
SuppressionAppliesTo
string · enum
Enum values:
all
broadcast
Mail category blocked by the suppression. all blocks transactional and broadcast mail. broadcast blocks broadcast mail only.
SuppressionReason
string · enum
Enum values:
spam_complaint
hard_bounce
unsubscribe
manual
Reason that the recipient is suppressed.
SuppressionSourceMessageData
idavailablesubjectcreated_atTeamData
idnametypeEnum values:
personal
business
planEnum values:
free
starter
growth
pro
included_volumeNumber of emails included in the team's monthly plan.
verified_atcreated_atfeaturesdomains_countprojects_countmembers_counttierDeprecated alias for included_volume.
TeamMemberData
idnameemail​object · required
​TeamMemberProjectAccessData · required
joined_atTeamMemberProjectAccessData
scopeEnum values:
all
selected
​object[] · required
TeamRoleData
idname​required
permissionsEnum values:
team:manage
billing:manage
security:manage
audit:read
support:manage
members:read
members:manage
roles:manage
assignableTeamUsageDetailData
​TeamUsagePeriodData · required
​TeamUsagePeriodData[] · required
TeamUsagePeriodData
usagelast_incremented_atperiod_startperiod_endUpdateProjectData
namesmtp_enabledredact_email_contentdefault_route_idUpdateRouteInboundSettingsData
inbound_domainCustom receiving domain for inbound routes, such as support.example.com or *.m.example.com. Address patterns such as @.m.example.com are normalized
inbound_spam_thresholdInbound spam threshold for inbound routes. Higher values are more permissive
​
UpdateRouteSettingsData
track_opensEnable open tracking for transactional and broadcast routes. Requires email tracking access
track_clicksEnable click tracking for transactional and broadcast routes. Requires email tracking access
generate_plaintext_fallbackOpt in to generated plaintext fallbacks for HTML-only outbound messages on transactional and broadcast routes. Customer-provided plaintext is always preserved
suppress_auto_respondersAdd outbound headers that suppress auto-responders for transactional and broadcast routes. Customer-provided header values are preserved
suppress_disposable_recipientsSkip disposable email recipients for transactional and broadcast routes. This check applies to each message and does not add recipients to suppression lists
​
disable_hosted_unsubscribeDisable Lettermint-hosted unsubscribe link injection for broadcast routes. Available only when enabled for the team
redact_email_contentRedact email content in the dashboard for this route. Requires email redaction access
UpdateWebhookData
nameurleventsEnum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
enabledinclude_machine_eventsscopeEnum values:
team
project
route
project_idsroute_idsroute_idWebhookData
idscopeEnum values:
team
project
route
project_idsroute_idsnameurleventsenabledinclude_machine_eventslast_called_atcreated_atupdated_atroute_idUse route_ids.
WebhookDeliveryData
idwebhook_idevent_typeEnum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
source_scopesource_project_idsource_route_idstatusEnum values:
pending
success
failed
client_error
server_error
timeout
attempt_numberhttp_status_codeduration_mspayloadresponse_bodyresponse_headerserror_messagedelivered_attimestampWebhookDeliveryListData
idwebhook_idevent_typeEnum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
source_scopesource_project_idsource_route_idstatusEnum values:
pending
success
failed
client_error
server_error
timeout
attempt_numberhttp_status_codeduration_msdelivered_atcreated_atWebhookDeliveryStatus
string · enum
Enum values:
pending
success
failed
client_error
server_error
timeout
WebhookEvent
string · enum
Enum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
WebhookListData
idscopeEnum values:
team
project
route
project_idsroute_idsnameurleventsenabledlast_called_atcreated_atupdated_atroute_idUse route_ids.
WebhookSecretData
idscopeEnum values:
team
project
route
project_idsroute_idsnameurleventsenabledinclude_machine_eventssecretlast_called_atcreated_atupdated_atroute_idUse route_ids.