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 · 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 · date-time · required​string · required​MessageType · enum · required​MessageStatus · enum · 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​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​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 · 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 · required​string · maxLength: 255 · required​string · uri · maxLength: 500 · required​WebhookEvent[] · minItems: 1 · required​boolean | null​boolean | null​string · required​SuppressionType · enum · required​string · required​SuppressionReason · enum · required​SuppressionScope · enum · required​string | null · required​string | null · required​string · date-time · 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​string · maxLength: 255​string · uri · maxLength: 500​WebhookEvent[] · minItems: 1​boolean​boolean​string · required​string · required​string · required​string · required​string[] · minItems: 1 · required​boolean · required​boolean · required​string | null · date-time · required​string · date-time · required​string · date-time · required​string​string · required​string · required​WebhookEvent · enum · 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​WebhookDeliveryStatus · enum · required​integer · required​integer | null · required​integer | null · required​string | null · date-time · required​string · date-time · required​string · required​string · required​string · required​string · required​WebhookEvent[] · required​boolean · required​string | null · date-time · required​string · date-time · required​string · date-time · required
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:
pending
queued
suppressed
processed
delivered
opened
clicked
soft_bounced
status_changed_attagfrom_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:
queued
processed
suppressed
delivered
auto_replied
soft_bounced
hard_bounced
spam_complaint
​object | null · required
timestampMessageEventType
string · enum
Enum values:
queued
processed
suppressed
delivered
auto_replied
soft_bounced
hard_bounced
spam_complaint
MessageListData
idtypeEnum values:
inbound
outbound
statusEnum values:
pending
queued
suppressed
processed
delivered
opened
clicked
soft_bounced
from_emailfrom_namesubject​array | null · required
​array | null · required
​array | null · required
reply_totagstatus_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:
pending
queued
suppressed
processed
delivered
opened
clicked
soft_bounced
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_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_clickedStatsData
fromto​StatsTotalsData · required
​StatsDailyData[] · required
StatsRequestData
fromtoproject_idinclude_machineDefault: 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_clickedStatsTypeData
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
reasonEnum values:
spam_complaint
hard_bounce
unsubscribe
manual
scopeEnum values:
global
team
project
route
emailemailsroute_idproject_idStoreWebhookData
route_idnameurleventsEnum 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
SuppressedRecipientData
idtypeEnum values:
email
domain
extension
valuereasonEnum values:
spam_complaint
hard_bounce
unsubscribe
manual
scopeEnum values:
global
team
project
route
project_idroute_idcreated_atupdated_at​
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
​
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_eventsWebhookData
idroute_idnameurleventsenabledinclude_machine_eventslast_called_atcreated_atupdated_atsecretWebhookDeliveryData
idwebhook_idevent_typeEnum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
statusEnum 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
statusEnum 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
idroute_idnameurleventsEnum values:
message.created
message.sent
message.delivered
message.auto_replied
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
enabledlast_called_atcreated_atupdated_at