Lettermint Team API
​string · required​string · required​string | null · date-time · required​string · date-time · required​string · required​RecordType · enum · required​string · required​string · required​string · required​DnsRecordStatus · enum · required
​string | null · required​string | null · date-time · required​string · required​string · required​DomainStatus · 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 · required​integer · required​integer · required​integer · required​number · required​string · required​string · required​boolean · required​string | null · required​string | null · date-time · required​string | null · date-time · required​string | null · required​string · required​string · required​integer​integer​integer​string · required​string · required​boolean · required​integer · 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​string​string · date-time​number​AttachmentDelivery · enum​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​string · maxLength: 255 · required​RouteType · enum · required​string | null · maxLength: 255​SuppressionReason · enum · required​string · enum · required​string | null · email · maxLength: 255​string | null · uuid​string | null · uuid​array | null · minItems: 1 · maxItems: 1000​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​string · required​TeamType · enum · required​Plan · enum · required​VolumeTier · enum · required​string | null · date-time · required​string · date-time · required​string[]​integer​integer​integer​string · required​string | null · required​string | null · date-time · required​integer · required​string | null · date-time · required​string · date-time · required​string · date-time · required​string | null · maxLength: 255​boolean | null​string | null · uuid​string · maxLength: 255​string · uri · maxLength: 500​boolean​boolean​WebhookEvent[] · minItems: 1​string · required​string · required​string · required​string | null · required​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
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
iddomainstatus_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
verified_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
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_score​SpamSymbol[]
MessageEventData
message_ideventEnum values:
queued
processed
suppressed
delivered
soft_bounced
hard_bounced
spam_complaint
failed
​object | null · required
timestampMessageEventType
string · enum
Enum values:
queued
processed
suppressed
delivered
soft_bounced
hard_bounced
spam_complaint
failed
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_totagcreated_atMessageStatsData
messages_transactionalmessages_broadcastmessages_inbounddeliverabilityMessageStatus
string · enum
Enum values:
pending
queued
suppressed
processed
delivered
opened
clicked
soft_bounced
ProjectData
idnamesmtp_enableddefault_route_idtoken_generated_attoken_last_used_attoken_last_used_ipcreated_atupdated_at​RouteData[]
routes_count​DomainData[]
domains_countteam_members_count​
ProjectListData
idnamesmtp_enabledroutes_countdomains_countteam_members_count​MessageStatsData · required
created_atupdated_atRouteData
idproject_idslugnameroute_typeEnum values:
transactional
broadcast
inbound
is_defaultcreated_atupdated_atinbound_addressinbound_domaininbound_domain_verified_atinbound_spam_thresholdattachment_deliveryEnum values:
inline
url
​ProjectData
webhooks_countsuppressed_recipients_count​
RouteListData
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
StoreRouteData
nameroute_typeEnum values:
transactional
broadcast
inbound
slugStoreSuppressionData
reasonEnum values:
spam_complaint
hard_bounce
unsubscribe
manual
scopeEnum values:
team
project
route
emailroute_idproject_idemailsStoreWebhookData
route_idnameurleventsEnum values:
message.created
message.sent
message.delivered
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
message.suppressed
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_atTeamData
idnametypeEnum values:
personal
business
planEnum values:
free
starter
growth
pro
tierEnum values:
300
10000
50000
125000
500000
750000
1000000
1500000
verified_atcreated_atfeaturesdomains_countprojects_countmembers_countTeamMemberData
idrolejoined_at​UserData
TeamUsageDetailData
​TeamUsagePeriodData · required
​TeamUsagePeriodData[] · required
TeamUsagePeriodData
usagelast_incremented_atperiod_startperiod_endUpdateProjectData
namesmtp_enableddefault_route_idUpdateWebhookData
nameurlenabledinclude_machine_eventseventsEnum values:
message.created
message.sent
message.delivered
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
message.suppressed
UserData
idnameemailavatarWebhookData
idroute_idnameurleventsenabledinclude_machine_eventslast_called_atcreated_atupdated_atsecretWebhookDeliveryData
idwebhook_idevent_typeEnum values:
message.created
message.sent
message.delivered
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
message.suppressed
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.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
message.suppressed
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.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
message.suppressed
WebhookListData
idroute_idnameurleventsEnum values:
message.created
message.sent
message.delivered
message.hard_bounced
message.soft_bounced
message.spam_complaint
message.failed
message.suppressed
enabledlast_called_atcreated_atupdated_at