MailSlurp Platform
API Reference
Build with MailSlurp APIs for email, SMS, phone numbers, webhooks, and AI workflows. Browse controllers, inspect request and response payloads, and jump to exact endpoints with deep links.
Reference sources
Use these docs and machine-readable specs to integrate faster.
Authentication
Every request must include an API key in the x-api-key header. Sign in to the MailSlurp web app to create an API key (free accounts supported), then apply it below to personalize cURL examples on this page.
No API key applied yet.
EmailController
49 endpoints
Endpoints for managing email entities. Send and read email using the email API. You can fetch emails and attachments, reply to emails, and send new emails with this controller. Emails belong to inboxes. Each inbox can contain unlimited emails that are either permanent or temporary depending on your setup. Because emails can be quite large when attachments and content are fetched most responses only include a preview of the email and its most important features, like subject, recipients etc and an ID. Many list results are in a paginated form using an index (zero based) and a page size. To receive email decide on either `waitFor` methods (such as `waitForLatestEmail` on the `WaitForController`) to wait for emails to arrive. Use `getEmails` on `EmailController` or `getInboxEmails` on the `InboxController` to list existing emails. To access the body or attachments of an email you need to use the `getEmail` and `getAttachment` endpoints with specific inbox and email IDs. The body is returned on full email entities and contains the parsed body of the email. The email headers (such as recipients, subject etc.) are stored on the email object. You can access the RAW SMTP message via various `raw` methods. Attachments are treated as separate entities that have an ID and belong to the email. To fetch email attachments first fetch the full email then use a `downloadAttachment` method for each `attachmentID`. Attachments are transferred in a number of ways as either `application/octect-stream` byte arrays or as base64 encoded strings with meta data. You may prefer either depending on the environment you are in but the base64 implementations are typically safer. See the `AttachmentController`, `InboxController`, and `WaitForController` for similar methods.
get/emailsgetEmailsPaginatedGet all emails in all inboxes in paginated form. Email API list all.
/emailsgetEmailsPaginatedGet all emails in all inboxes in paginated form. Email API list all.
get/emails/{emailId}getEmailGet hydrated email (headers and body)
/emails/{emailId}getEmailGet hydrated email (headers and body)
get/emails/{emailId}/attachmentsgetEmailAttachmentsList attachment metadata for an email
/emails/{emailId}/attachmentsgetEmailAttachmentsList attachment metadata for an email
get/emails/{emailId}/attachments/{attachmentId}downloadAttachmentGet email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
/emails/{emailId}/attachments/{attachmentId}downloadAttachmentGet email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
get/emails/{emailId}/attachments/{attachmentId}/base64downloadAttachmentBase64Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
/emails/{emailId}/attachments/{attachmentId}/base64downloadAttachmentBase64Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
get/emails/{emailId}/attachments/{attachmentId}/metadatagetAttachmentMetaDataGet email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
/emails/{emailId}/attachments/{attachmentId}/metadatagetAttachmentMetaDataGet email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
get/emails/{emailId}/bodydownloadBodyGet email body as string. Returned as `plain/text` with content type header.
/emails/{emailId}/bodydownloadBodyGet email body as string. Returned as `plain/text` with content type header.
get/emails/{emailId}/body-bytesdownloadBodyBytesGet email body in bytes. Returned as `octet-stream` with content type header.
/emails/{emailId}/body-bytesdownloadBodyBytesGet email body in bytes. Returned as `octet-stream` with content type header.
get/emails/{emailId}/contentPartgetEmailContentPartGet email content part by content type
/emails/{emailId}/contentPartgetEmailContentPartGet email content part by content type
get/emails/{emailId}/contentPart/rawgetEmailContentPartContentGet multipart content part as raw response
/emails/{emailId}/contentPart/rawgetEmailContentPartContentGet multipart content part as raw response
get/emails/{emailId}/htmlgetEmailHTMLGet hydrated email HTML for browser rendering
/emails/{emailId}/htmlgetEmailHTMLGet hydrated email HTML for browser rendering
get/emails/{emailId}/html/jsongetEmailHTMLJsonGet hydrated email HTML wrapped in JSON
/emails/{emailId}/html/jsongetEmailHTMLJsonGet hydrated email HTML wrapped in JSON
get/emails/{emailId}/htmlQuerygetEmailHTMLQueryQuery hydrated HTML body and return matching text lines
/emails/{emailId}/htmlQuerygetEmailHTMLQueryQuery hydrated HTML body and return matching text lines
get/emails/{emailId}/linksgetEmailLinksExtract links from an email HTML body
/emails/{emailId}/linksgetEmailLinksExtract links from an email HTML body
get/emails/{emailId}/rawgetRawEmailContentsGet raw email string. Returns unparsed raw SMTP message with headers and body.
/emails/{emailId}/rawgetRawEmailContentsGet raw email string. Returns unparsed raw SMTP message with headers and body.
get/emails/{emailId}/raw/jsongetRawEmailJsonGet raw email in JSON. Unparsed SMTP message in JSON wrapper format.
/emails/{emailId}/raw/jsongetRawEmailJsonGet raw email in JSON. Unparsed SMTP message in JSON wrapper format.
get/emails/{emailId}/signaturegetEmailSignatureExtract signature from an inbound email
/emails/{emailId}/signaturegetEmailSignatureExtract signature from an inbound email
get/emails/{emailId}/summarygetEmailSummaryGet email summary (headers/metadata only)
/emails/{emailId}/summarygetEmailSummaryGet email summary (headers/metadata only)
get/emails/{emailId}/textLinesgetEmailTextLinesExtract normalized text lines from email body
/emails/{emailId}/textLinesgetEmailTextLinesExtract normalized text lines from email body
get/emails/{emailId}/urlsgetEmailPreviewURLsGet email URLs for viewing in browser or downloading
/emails/{emailId}/urlsgetEmailPreviewURLsGet email URLs for viewing in browser or downloading
get/emails/emails/countgetEmailCountGet email count
/emails/emails/countgetEmailCountGet email count
get/emails/gravatarForgetGravatarUrlForEmailAddressGet Gravatar URL for an email address
/emails/gravatarForgetGravatarUrlForEmailAddressGet Gravatar URL for an email address
get/emails/latestgetLatestEmailGet latest email in all inboxes. Most recently received.
/emails/latestgetLatestEmailGet latest email in all inboxes. Most recently received.
get/emails/latestIngetLatestEmailInInbox_1Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
/emails/latestIngetLatestEmailInInbox_1Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
get/emails/offset-paginatedgetEmailsOffsetPaginatedGet all emails in all inboxes in paginated form. Email API list all.
/emails/offset-paginatedgetEmailsOffsetPaginatedGet all emails in all inboxes in paginated form. Email API list all.
get/emails/organizationgetOrganizationEmailsPaginatedList organization-visible emails
/emails/organizationgetOrganizationEmailsPaginatedList organization-visible emails
get/emails/threadsgetEmailThreadsList email threads in paginated form
/emails/threadsgetEmailThreadsList email threads in paginated form
get/emails/threads/{threadId}getEmailThreadGet email thread metadata by thread ID
/emails/threads/{threadId}getEmailThreadGet email thread metadata by thread ID
get/emails/threads/{threadId}/itemsgetEmailThreadItemsGet messages in a specific email thread
/emails/threads/{threadId}/itemsgetEmailThreadItemsGet messages in a specific email thread
get/emails/unreadCountgetUnreadEmailCountGet unread email count
/emails/unreadCountgetUnreadEmailCountGet unread email count
post/emailssendEmailSourceOptionalSend email
/emailssendEmailSourceOptionalSend email
post/emails/{emailId}/check-email-bodycheckEmailBodyCheck email body for broken links, images, and spelling issues
/emails/{emailId}/check-email-bodycheckEmailBodyCheck email body for broken links, images, and spelling issues
post/emails/{emailId}/check-email-body-feature-supportcheckEmailBodyFeatureSupportCheck client support for features used in a stored email body
/emails/{emailId}/check-email-body-feature-supportcheckEmailBodyFeatureSupportCheck client support for features used in a stored email body
post/emails/{emailId}/codesgetEmailCodesExtract verification codes from an email
/emails/{emailId}/codesgetEmailCodesExtract verification codes from an email
post/emails/{emailId}/contentMatchgetEmailContentMatchRun regex against hydrated email body and return matches
/emails/{emailId}/contentMatchgetEmailContentMatchRun regex against hydrated email body and return matches
post/emails/{emailId}/forwardforwardEmailForward email to recipients
/emails/{emailId}/forwardforwardEmailForward email to recipients
post/emails/{emailId}/imap-flag-operationapplyImapFlagOperationSet IMAP flags associated with a message. Only supports '\Seen' flag.
/emails/{emailId}/imap-flag-operationapplyImapFlagOperationSet IMAP flags associated with a message. Only supports '\Seen' flag.
post/emails/{emailId}/screenshot/base64getEmailScreenshotAsBase64Take a screenshot of an email in a browser and return base64 encoded string
/emails/{emailId}/screenshot/base64getEmailScreenshotAsBase64Take a screenshot of an email in a browser and return base64 encoded string
post/emails/{emailId}/screenshot/binarygetEmailScreenshotAsBinaryTake a screenshot of an email in a browser
/emails/{emailId}/screenshot/binarygetEmailScreenshotAsBinaryTake a screenshot of an email in a browser
post/emails/{emailId}/validatevalidateEmailValidate email HTML contents
/emails/{emailId}/validatevalidateEmailValidate email HTML contents
post/emails/can-sendcanSendCheck whether an email send would be accepted
/emails/can-sendcanSendCheck whether an email send would be accepted
post/emails/check-email-client-supportcheckEmailClientSupportCheck email-client support for a provided HTML body
/emails/check-email-client-supportcheckEmailClientSupportCheck email-client support for a provided HTML body
post/emails/searchsearchEmailsGet all emails by search criteria. Return in paginated form.
/emails/searchsearchEmailsGet all emails by search criteria. Return in paginated form.
put/emails/{emailId}replyToEmailReply to an email
/emails/{emailId}replyToEmailReply to an email
put/emails/{emailId}/favouritesetEmailFavouritedSet email favourited state
/emails/{emailId}/favouritesetEmailFavouritedSet email favourited state
patch/emails/{emailId}/readmarkAsReadMark an email as read or unread
/emails/{emailId}/readmarkAsReadMark an email as read or unread
patch/emails/readmarkAllAsReadMark all emails as read or unread
/emails/readmarkAllAsReadMark all emails as read or unread
delete/emailsdeleteAllEmailsDelete all emails in all inboxes.
/emailsdeleteAllEmailsDelete all emails in all inboxes.
delete/emails/{emailId}deleteEmailDelete an email
/emails/{emailId}deleteEmailDelete an email
InboxController
64 endpoints
Endpoints for creating and managing inboxes. Also includes endpoints for listing emails within inboxes. Inboxes are a core feature of MailSlurp. Each inbox has a unique ID and emailAddress. If your plan allows custom domains you can create inboxes with custom addresses that end in your domain. By default inboxes are assigned a random email address ending in `@mailslurp.biz`. Use the domainPool options to use a randomly selected domain from a pool of available domains. Whenever you create an inbox MailSlurp will register the address and store any emails sent to the address within your inbox. You can use the `InboxController` endpoints to list the emails in an inbox. To get the contents or attachments of an email use the ID returned from `InboxController` methods to call the `EmailController` endpoints."
get/inboxesgetInboxesList Inboxes and email addresses
Deprecated
/inboxesgetInboxesList Inboxes and email addresses
get/inboxes/{inboxId}getInboxGet Inbox. Returns properties of an inbox.
/inboxes/{inboxId}getInboxGet Inbox. Returns properties of an inbox.
get/inboxes/{inboxId}/delivery-statusgetDeliveryStatusesByInboxIdGet all email delivery statuses for an inbox
Deprecated
/inboxes/{inboxId}/delivery-statusgetDeliveryStatusesByInboxIdGet all email delivery statuses for an inbox
get/inboxes/{inboxId}/emailsgetEmailsGet emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
/inboxes/{inboxId}/emailsgetEmailsGet emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
get/inboxes/{inboxId}/emails/countgetInboxEmailCountGet email count in inbox
/inboxes/{inboxId}/emails/countgetInboxEmailCountGet email count in inbox
get/inboxes/{inboxId}/emails/paginatedgetInboxEmailsPaginatedGet inbox emails paginated
/inboxes/{inboxId}/emails/paginatedgetInboxEmailsPaginatedGet inbox emails paginated
get/inboxes/{inboxId}/plus-addressesgetInboxPlusAddressesGet sub address plus address aliases for an inbox
/inboxes/{inboxId}/plus-addressesgetInboxPlusAddressesGet sub address plus address aliases for an inbox
get/inboxes/{inboxId}/plus-addresses/{plusAddressId}getInboxPlusAddressGet sub address plus address for an inbox
/inboxes/{inboxId}/plus-addresses/{plusAddressId}getInboxPlusAddressGet sub address plus address for an inbox
get/inboxes/{inboxId}/plus-addresses/{plusAddressId}/emailsgetInboxPlusAddressEmailsForPlusAddressIdGet emails for a given inbox plus address
/inboxes/{inboxId}/plus-addresses/{plusAddressId}/emailsgetInboxPlusAddressEmailsForPlusAddressIdGet emails for a given inbox plus address
get/inboxes/{inboxId}/plus-addresses/emailsgetInboxPlusAddressEmailsGet emails for a given inbox plus address
/inboxes/{inboxId}/plus-addresses/emailsgetInboxPlusAddressEmailsGet emails for a given inbox plus address
get/inboxes/{inboxId}/rulesetslistInboxRulesetsList inbox rulesets
/inboxes/{inboxId}/rulesetslistInboxRulesetsList inbox rulesets
get/inboxes/{inboxId}/scheduled-jobsgetScheduledJobsByInboxIdGet all scheduled email sending jobs for the inbox
/inboxes/{inboxId}/scheduled-jobsgetScheduledJobsByInboxIdGet all scheduled email sending jobs for the inbox
get/inboxes/{inboxId}/sentgetInboxSentEmailsGet Inbox Sent Emails
Deprecated
/inboxes/{inboxId}/sentgetInboxSentEmailsGet Inbox Sent Emails
get/inboxes/{inboxId}/sent/countgetInboxSentCountGet sent email count in inbox
/inboxes/{inboxId}/sent/countgetInboxSentCountGet sent email count in inbox
get/inboxes/{inboxId}/tracking-pixelslistInboxTrackingPixelsList inbox tracking pixels
/inboxes/{inboxId}/tracking-pixelslistInboxTrackingPixelsList inbox tracking pixels
get/inboxes/automationsdoesInboxHaveAutomationsDoes inbox have automations
/inboxes/automationsdoesInboxHaveAutomationsDoes inbox have automations
get/inboxes/byEmailAddressgetInboxByEmailAddressSearch for an inbox with the provided email address
/inboxes/byEmailAddressgetInboxByEmailAddressSearch for an inbox with the provided email address
get/inboxes/byNamegetInboxByNameSearch for an inbox with the given name
/inboxes/byNamegetInboxByNameSearch for an inbox with the given name
get/inboxes/countgetInboxCountGet total inbox count
/inboxes/countgetInboxCountGet total inbox count
get/inboxes/existsdoesInboxExistDoes inbox exist
/inboxes/existsdoesInboxExistDoes inbox exist
get/inboxes/getLatestEmailgetLatestEmailInInboxGet latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
/inboxes/getLatestEmailgetLatestEmailInInboxGet latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
get/inboxes/idsgetInboxIdsGet all inbox IDs
Deprecated
/inboxes/idsgetInboxIdsGet all inbox IDs
get/inboxes/imap-accessgetImapAccessGet IMAP access usernames and passwords
/inboxes/imap-accessgetImapAccessGet IMAP access usernames and passwords
get/inboxes/imap-smtp-accessgetImapSmtpAccessGet IMAP and SMTP access usernames and passwords
/inboxes/imap-smtp-accessgetImapSmtpAccessGet IMAP and SMTP access usernames and passwords
get/inboxes/imap-smtp-access/envgetImapSmtpAccessEnvGet IMAP and SMTP access details in .env format
/inboxes/imap-smtp-access/envgetImapSmtpAccessEnvGet IMAP and SMTP access details in .env format
get/inboxes/imap-smtp-access/serversgetImapSmtpAccessServersGet IMAP and SMTP server hosts
/inboxes/imap-smtp-access/serversgetImapSmtpAccessServersGet IMAP and SMTP server hosts
get/inboxes/offset-paginatedgetAllInboxesOffsetPaginatedList All Inboxes Offset Paginated
/inboxes/offset-paginatedgetAllInboxesOffsetPaginatedList All Inboxes Offset Paginated
get/inboxes/organizationgetOrganizationInboxesList Organization Inboxes Paginated
Deprecated
/inboxes/organizationgetOrganizationInboxesList Organization Inboxes Paginated
get/inboxes/outboxesgetOutboxesList all inboxes with sent emails
/inboxes/outboxesgetOutboxesList all inboxes with sent emails
get/inboxes/paginatedgetAllInboxesList All Inboxes Paginated
/inboxes/paginatedgetAllInboxesList All Inboxes Paginated
get/inboxes/plus-addressesgetAllPlusAddressesGet all sub address plus address aliases for an inbox
/inboxes/plus-addressesgetAllPlusAddressesGet all sub address plus address aliases for an inbox
get/inboxes/plus-addresses/{plusAddressId}getInboxPlusAddressByIdGet sub address plus address by ID
/inboxes/plus-addresses/{plusAddressId}getInboxPlusAddressByIdGet sub address plus address by ID
get/inboxes/scheduled-jobsgetAllScheduledJobsGet all scheduled email sending jobs for account
/inboxes/scheduled-jobsgetAllScheduledJobsGet all scheduled email sending jobs for account
get/inboxes/scheduled-jobs/{jobId}getScheduledJobGet a scheduled email job
/inboxes/scheduled-jobs/{jobId}getScheduledJobGet a scheduled email job
get/inboxes/smtp-accessgetSmtpAccessGet SMTP access usernames and passwords
/inboxes/smtp-accessgetSmtpAccessGet SMTP access usernames and passwords
get/inboxes/tagsgetInboxTagsGet inbox tags
/inboxes/tagsgetInboxTagsGet inbox tags
get/inboxes/tags/inboxesgetInboxesByTagGet inboxes for a tag
/inboxes/tags/inboxesgetInboxesByTagGet inboxes for a tag
get/inboxes/tags/paginatedgetInboxTagsPaginatedGet inbox tags paginated
/inboxes/tags/paginatedgetInboxTagsPaginatedGet inbox tags paginated
post/inboxescreateInboxCreate an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
/inboxescreateInboxCreate an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
post/inboxes/{inboxId}sendEmailSend Email
/inboxes/{inboxId}sendEmailSend Email
post/inboxes/{inboxId}/confirmsendEmailAndConfirmSend email and return sent confirmation
/inboxes/{inboxId}/confirmsendEmailAndConfirmSend email and return sent confirmation
post/inboxes/{inboxId}/plus-addresses/get-or-creategetOrCreateInboxPlusAddressGet or create a plus address by full address
/inboxes/{inboxId}/plus-addresses/get-or-creategetOrCreateInboxPlusAddressGet or create a plus address by full address
post/inboxes/{inboxId}/rulesetscreateInboxRulesetCreate an inbox ruleset
/inboxes/{inboxId}/rulesetscreateInboxRulesetCreate an inbox ruleset
post/inboxes/{inboxId}/send-test-emailsendTestEmailSend a test email to inbox
/inboxes/{inboxId}/send-test-emailsendTestEmailSend a test email to inbox
post/inboxes/{inboxId}/smtp-envelopesendSmtpEnvelopeSend email using an SMTP mail envelope and message body and return sent confirmation
/inboxes/{inboxId}/smtp-envelopesendSmtpEnvelopeSend email using an SMTP mail envelope and message body and return sent confirmation
post/inboxes/{inboxId}/with-queuesendEmailWithQueueSend email with queue
/inboxes/{inboxId}/with-queuesendEmailWithQueueSend email with queue
post/inboxes/{inboxId}/with-schedulesendWithScheduleSend email with with delay or schedule
/inboxes/{inboxId}/with-schedulesendWithScheduleSend email with with delay or schedule
post/inboxes/availableisEmailAddressAvailableIs email address available
/inboxes/availableisEmailAddressAvailableIs email address available
post/inboxes/get-or-create-plus-addressgetOrCreatePlusAddressByFullAddressGet or create a plus address by full address without inbox ID
/inboxes/get-or-create-plus-addressgetOrCreatePlusAddressByFullAddressGet or create a plus address by full address without inbox ID
post/inboxes/searchsearchInboxesSearch all inboxes and return matching inboxes
/inboxes/searchsearchInboxesSearch all inboxes and return matching inboxes
post/inboxes/withDefaultscreateInboxWithDefaultsCreate an inbox with default options. Uses MailSlurp domain pool address and is private.
/inboxes/withDefaultscreateInboxWithDefaultsCreate an inbox with default options. Uses MailSlurp domain pool address and is private.
post/inboxes/withOptionscreateInboxWithOptionsCreate an inbox with options. Extended options for inbox creation.
/inboxes/withOptionscreateInboxWithOptionsCreate an inbox with options. Extended options for inbox creation.
put/inboxes/{inboxId}/favouritesetInboxFavouritedSet inbox favourited state
/inboxes/{inboxId}/favouritesetInboxFavouritedSet inbox favourited state
patch/inboxes/{inboxId}updateInboxUpdate Inbox. Change name and description. Email address is not editable.
/inboxes/{inboxId}updateInboxUpdate Inbox. Change name and description. Email address is not editable.
patch/inboxes/imap-accessupdateImapAccessUpdate IMAP access usernames and passwords
/inboxes/imap-accessupdateImapAccessUpdate IMAP access usernames and passwords
patch/inboxes/smtp-accessupdateSmtpAccessUpdate SMTP access usernames and passwords
/inboxes/smtp-accessupdateSmtpAccessUpdate SMTP access usernames and passwords
delete/inboxesdeleteAllInboxesDelete all inboxes
/inboxesdeleteAllInboxesDelete all inboxes
delete/inboxes/{inboxId}deleteInboxDelete inbox
/inboxes/{inboxId}deleteInboxDelete inbox
delete/inboxes/{inboxId}/deleteAllInboxEmailsdeleteAllInboxEmailsDelete all emails in a given inboxes.
/inboxes/{inboxId}/deleteAllInboxEmailsdeleteAllInboxEmailsDelete all emails in a given inboxes.
delete/inboxes/by-descriptiondeleteAllInboxesByDescriptionDelete inboxes by description
/inboxes/by-descriptiondeleteAllInboxesByDescriptionDelete inboxes by description
delete/inboxes/by-namedeleteAllInboxesByNameDelete inboxes by name
/inboxes/by-namedeleteAllInboxesByNameDelete inboxes by name
delete/inboxes/by-tagdeleteAllInboxesByTagDelete inboxes by tag
/inboxes/by-tagdeleteAllInboxesByTagDelete inboxes by tag
delete/inboxes/expiredflushExpiredRemove expired inboxes
/inboxes/expiredflushExpiredRemove expired inboxes
delete/inboxes/scheduled-jobs/{jobId}cancelScheduledJobCancel a scheduled email job
/inboxes/scheduled-jobs/{jobId}cancelScheduledJobCancel a scheduled email job
PhoneController
30 endpoints
Endpoints for managing phone numbers and addresses
get/phone/consentgetConsentStatusGet consent status
/phone/consentgetConsentStatusGet consent status
get/phone/emergency-addressesgetEmergencyAddressesGet emergency addresses
/phone/emergency-addressesgetEmergencyAddressesGet emergency addresses
get/phone/emergency-addresses/{addressId}getEmergencyAddressGet an emergency address
/phone/emergency-addresses/{addressId}getEmergencyAddressGet an emergency address
get/phone/numbersgetPhoneNumbersGet phone numbers
/phone/numbersgetPhoneNumbersGet phone numbers
get/phone/numbers/{phoneNumberId}getPhoneNumberGet a phone number by ID
/phone/numbers/{phoneNumberId}getPhoneNumberGet a phone number by ID
get/phone/numbers/{phoneNumberId}/message-threadsgetPhoneMessageThreadsGet the latest message preview for a thread
/phone/numbers/{phoneNumberId}/message-threadsgetPhoneMessageThreadsGet the latest message preview for a thread
get/phone/numbers/{phoneNumberId}/message-threads/{otherNumber}getPhoneMessageThreadItemsGet messages in a phone thread
/phone/numbers/{phoneNumberId}/message-threads/{otherNumber}getPhoneMessageThreadItemsGet messages in a phone thread
get/phone/numbers/{phoneNumberId}/smsgetSmsByPhoneNumberList SMS messages for a phone number
/phone/numbers/{phoneNumberId}/smsgetSmsByPhoneNumberList SMS messages for a phone number
get/phone/numbers/{phoneNumberId}/sms-sentgetSentSmsByPhoneNumberList sent TXT messages for a phone number
/phone/numbers/{phoneNumberId}/sms-sentgetSentSmsByPhoneNumberList sent TXT messages for a phone number
get/phone/numbers/by-namegetPhoneNumberByNameGet a phone number by name
/phone/numbers/by-namegetPhoneNumberByNameGet a phone number by name
get/phone/numbers/by-phone-numbergetPhoneNumberByPhoneNumberGet a phone number by phone number
/phone/numbers/by-phone-numbergetPhoneNumberByPhoneNumberGet a phone number by phone number
get/phone/numbers/message-threadsgetAllPhoneMessageThreadsGet the latest messages for all phones
/phone/numbers/message-threadsgetAllPhoneMessageThreadsGet the latest messages for all phones
get/phone/plansgetPhonePlansGet phone plans
/phone/plansgetPhonePlansGet phone plans
get/phone/plans/availabilitygetPhonePlansAvailabilityGet phone plans availability
/phone/plans/availabilitygetPhonePlansAvailabilityGet phone plans availability
get/phone/releasesgetAllPhoneNumberReleasesGet all phone number releases
/phone/releasesgetAllPhoneNumberReleasesGet all phone number releases
get/phone/releases/{releaseId}getPhoneNumberReleaseGet phone number release
/phone/releases/{releaseId}getPhoneNumberReleaseGet phone number release
get/phone/releases/{releaseId}/reassignreassignPhoneNumberReleaseReassign phone number release
/phone/releases/{releaseId}/reassignreassignPhoneNumberReleaseReassign phone number release
get/phone/summarygetPhoneSummaryGet phone summary
/phone/summarygetPhoneSummaryGet phone summary
post/phonecreatePhoneNumberAdd phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.
/phonecreatePhoneNumberAdd phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.
post/phone/consentsetConsentStatusSet consent status
/phone/consentsetConsentStatusSet consent status
post/phone/emergency-addressescreateEmergencyAddressCreate an emergency address
/phone/emergency-addressescreateEmergencyAddressCreate an emergency address
post/phone/numbers/{phoneNumberId}/smssendSmsFromPhoneNumberSend TXT message from a phone number
/phone/numbers/{phoneNumberId}/smssendSmsFromPhoneNumberSend TXT message from a phone number
post/phone/numbers/{phoneNumberId}/testtestPhoneNumberSendSmsTest sending an SMS to a number
/phone/numbers/{phoneNumberId}/testtestPhoneNumberSendSmsTest sending an SMS to a number
post/phone/validatevalidatePhoneNumberVerify validity of a phone number
/phone/validatevalidatePhoneNumberVerify validity of a phone number
put/phone/numbers/{phoneNumberId}updatePhoneNumberUpdate a phone number
/phone/numbers/{phoneNumberId}updatePhoneNumberUpdate a phone number
put/phone/numbers/{phoneNumberId}/favouritesetPhoneFavouritedSet phone favourited state
/phone/numbers/{phoneNumberId}/favouritesetPhoneFavouritedSet phone favourited state
delete/phone/emergency-addresses/{addressId}deleteEmergencyAddressDelete an emergency address
/phone/emergency-addresses/{addressId}deleteEmergencyAddressDelete an emergency address
delete/phone/numbersdeleteAllPhoneNumberDelete all phone numbers
/phone/numbersdeleteAllPhoneNumberDelete all phone numbers
delete/phone/numbers/{phoneNumberId}deletePhoneNumberDelete a phone number
/phone/numbers/{phoneNumberId}deletePhoneNumberDelete a phone number
delete/phone/numbers/{phoneNumberId}/message-threads/{otherNumber}deletePhoneMessageThreadItemsDelete messages in a phone thread
/phone/numbers/{phoneNumberId}/message-threads/{otherNumber}deletePhoneMessageThreadItemsDelete messages in a phone thread
SmsController
16 endpoints
Endpoints for managing SMS
get/smsgetAllSmsMessagesNo summary provided for this endpoint.
/smsgetAllSmsMessagesNo summary provided for this endpoint.
get/sms/{smsId}getSmsMessageGet SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
/sms/{smsId}getSmsMessageGet SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
get/sms/{smsId}/replygetReplyForSmsMessageGet reply for an SMS message
/sms/{smsId}/replygetReplyForSmsMessageGet reply for an SMS message
get/sms/countgetSmsCountGet SMS count
/sms/countgetSmsCountGet SMS count
get/sms/sentgetSentSmsMessagesPaginatedGet all SMS messages in all phone numbers in paginated form. .
/sms/sentgetSentSmsMessagesPaginatedGet all SMS messages in all phone numbers in paginated form. .
get/sms/sent/{sentSmsId}getSentSmsMessageGet sent SMS content including body. Expects sent SMS to exist by ID.
/sms/sent/{sentSmsId}getSentSmsMessageGet sent SMS content including body. Expects sent SMS to exist by ID.
get/sms/sent/countgetSentSmsCountGet sent SMS count
/sms/sent/countgetSentSmsCountGet sent SMS count
get/sms/unreadCountgetUnreadSmsCountGet unread SMS count
/sms/unreadCountgetUnreadSmsCountGet unread SMS count
post/sms/{smsId}/codesgetSmsCodesExtract verification codes from an SMS
/sms/{smsId}/codesgetSmsCodesExtract verification codes from an SMS
post/sms/{smsId}/replyreplyToSmsMessageSend a reply to a received SMS message. Replies are sent from the receiving number.
/sms/{smsId}/replyreplyToSmsMessageSend a reply to a received SMS message. Replies are sent from the receiving number.
post/sms/sendsendSmsNo summary provided for this endpoint.
/sms/sendsendSmsNo summary provided for this endpoint.
put/sms/{smsId}/favouritesetSmsFavouritedNo summary provided for this endpoint.
/sms/{smsId}/favouritesetSmsFavouritedNo summary provided for this endpoint.
delete/smsdeleteSmsMessagesDelete all SMS messages
/smsdeleteSmsMessagesDelete all SMS messages
delete/sms/{smsId}deleteSmsMessageDelete SMS message.
/sms/{smsId}deleteSmsMessageDelete SMS message.
delete/sms/sentdeleteSentSmsMessagesDelete all sent SMS messages
/sms/sentdeleteSentSmsMessagesDelete all sent SMS messages
delete/sms/sent/{sentSmsId}deleteSentSmsMessageDelete sent SMS message.
/sms/sent/{sentSmsId}deleteSentSmsMessageDelete sent SMS message.
AIController
21 endpoints
AI endpoints for generating structured content, automations, and analyzing emails and SMS.
get/ai/transformergetTransformersList transformers
/ai/transformergetTransformersList transformers
get/ai/transformer/{id}getTransformerGet a transformer
/ai/transformer/{id}getTransformerGet a transformer
get/ai/transformer/mappingsgetTransformerMappingsGet transformer mappings
/ai/transformer/mappingsgetTransformerMappingsGet transformer mappings
get/ai/transformer/mappings/{id}getTransformerMappingGet transformer mapping
/ai/transformer/mappings/{id}getTransformerMappingGet transformer mapping
get/ai/transformer/resultsgetTransformerResultsGet transformer results
/ai/transformer/resultsgetTransformerResultsGet transformer results
get/ai/transformer/results/{id}getTransformerResultGet transformer result
/ai/transformer/results/{id}getTransformerResultGet transformer result
get/ai/transformer/results/tablegetTransformerResultsTableGet transformer results table
/ai/transformer/results/tablegetTransformerResultsTableGet transformer results table
post/ai/structured-content/attachmentgenerateStructuredContentFromAttachmentGenerate structured content for an attachment
/ai/structured-content/attachmentgenerateStructuredContentFromAttachmentGenerate structured content for an attachment
post/ai/structured-content/emailgenerateStructuredContentFromEmailGenerate structured content for an email
/ai/structured-content/emailgenerateStructuredContentFromEmailGenerate structured content for an email
post/ai/structured-content/smsgenerateStructuredContentFromSmsGenerate structured content for a TXT message
/ai/structured-content/smsgenerateStructuredContentFromSmsGenerate structured content for a TXT message
post/ai/structured-content/validatevalidateStructuredOutputSchemaValidate structured content schema
/ai/structured-content/validatevalidateStructuredOutputSchemaValidate structured content schema
post/ai/transformercreateTransformerCreate a transformer for reuse in automations
/ai/transformercreateTransformerCreate a transformer for reuse in automations
post/ai/transformer/invokeinvokeTransformerInvoke a transformer
/ai/transformer/invokeinvokeTransformerInvoke a transformer
post/ai/transformer/mappingscreateTransformerMappingsCreate transformer mapping
/ai/transformer/mappingscreateTransformerMappingsCreate transformer mapping
post/ai/transformer/mappings/{id}/matchtestTransformerMappingMatchTest transformer mapping match result
/ai/transformer/mappings/{id}/matchtestTransformerMappingMatchTest transformer mapping match result
post/ai/transformer/results/exportexportTransformerResultsExport transformer results
/ai/transformer/results/exportexportTransformerResultsExport transformer results
post/ai/transformer/results/export/{id}getExportTransformerResultsJobGet export transformer results job
/ai/transformer/results/export/{id}getExportTransformerResultsJobGet export transformer results job
delete/ai/transformerdeleteTransformersDelete all transformers
/ai/transformerdeleteTransformersDelete all transformers
delete/ai/transformer/{id}deleteTransformerDelete a transformer
/ai/transformer/{id}deleteTransformerDelete a transformer
delete/ai/transformer/mappingsdeleteAllTransformerMappingsDelete all transformer mapping
/ai/transformer/mappingsdeleteAllTransformerMappingsDelete all transformer mapping
delete/ai/transformer/mappings/{id}deleteTransformerMappingDelete transformer mapping
/ai/transformer/mappings/{id}deleteTransformerMappingDelete transformer mapping
AliasController
11 endpoints
"Endpoints for creating, listing, and deleting email aliases. Aliases must be validated. Email aliases can be used to hide real email addresses behind an alias. If you wish to receive emails with an alias attach an inbox to the alias. Whenever the inbox receives an email the email will be forwarded to the alias email address. See related `threads`. Threads can be used with aliases to enable replying to a proxied email. This means that when threads are enabled an email alias will create a new email thread for the message and set the replyTo and from headers on the subsequently proxied email to point to the threads unique email address. By replying to this address the thread will forward it to the original emails sender or replyTo and use the same subject and bcc and cc contacts as the email you are replying to. For more advanced email operations using aliases use the inboxId for the given alias.
get/aliasesgetAliasesGet all email aliases you have created
/aliasesgetAliasesGet all email aliases you have created
get/aliases/{aliasId}getAliasGet an email alias
/aliases/{aliasId}getAliasGet an email alias
get/aliases/{aliasId}/emailsgetAliasEmailsGet emails for an alias
/aliases/{aliasId}/emailsgetAliasEmailsGet emails for an alias
get/aliases/{aliasId}/threadsgetAliasThreadsGet threads created for an alias
/aliases/{aliasId}/threadsgetAliasThreadsGet threads created for an alias
get/aliases/threadsgetThreadsPaginatedGet all threads
/aliases/threadsgetThreadsPaginatedGet all threads
get/aliases/threads/{threadId}getThreadGet a thread
/aliases/threads/{threadId}getThreadGet a thread
post/aliasescreateAliasCreate an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
/aliasescreateAliasCreate an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
post/aliases/{aliasId}/emailssendAliasEmailSend an email from an alias inbox
/aliases/{aliasId}/emailssendAliasEmailSend an email from an alias inbox
put/aliases/{aliasId}updateAliasUpdate an email alias
/aliases/{aliasId}updateAliasUpdate an email alias
put/aliases/{aliasId}/emails/{emailId}replyToAliasEmailReply to an email
/aliases/{aliasId}/emails/{emailId}replyToAliasEmailReply to an email
delete/aliases/{aliasId}deleteAliasDelete an email alias
/aliases/{aliasId}deleteAliasDelete an email alias
api-audit-log-controller
3 endpoints
get/audit-logsgetAuditLogsNo summary provided for this endpoint.
/audit-logsgetAuditLogsNo summary provided for this endpoint.
get/audit-logs/{eventId}getAuditLogByEventIdNo summary provided for this endpoint.
/audit-logs/{eventId}getAuditLogByEventIdNo summary provided for this endpoint.
post/audit-logs/searchsearchAuditLogsNo summary provided for this endpoint.
/audit-logs/searchsearchAuditLogsNo summary provided for this endpoint.
AttachmentController
11 endpoints
Endpoints for uploading attachments. Attachments can be uploaded in a number of ways: as base64 encoded strings, as byte array octet streams, and as multipart form requests. Each upload method returns an array whose first element is the ID of the attachment. Use this Id to send the attachment with emails. See the EmailController `download` endpoints for downloading attachments. Attachment downloads are based on the email ID they belong to and can be downloaded using the email controller.
get/attachmentsgetAttachmentsGet email attachments
/attachmentsgetAttachmentsGet email attachments
get/attachments/{attachmentId}getAttachmentGet an attachment entity
/attachments/{attachmentId}getAttachmentGet an attachment entity
get/attachments/{attachmentId}/base64downloadAttachmentAsBase64EncodedGet email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
/attachments/{attachmentId}/base64downloadAttachmentAsBase64EncodedGet email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
get/attachments/{attachmentId}/bytesdownloadAttachmentAsBytesDownload attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
/attachments/{attachmentId}/bytesdownloadAttachmentAsBytesDownload attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
get/attachments/{attachmentId}/metadatagetAttachmentInfoGet email attachment metadata information
/attachments/{attachmentId}/metadatagetAttachmentInfoGet email attachment metadata information
post/attachmentsuploadAttachmentUpload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
/attachmentsuploadAttachmentUpload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
post/attachments/{attachmentId}/textextractAttachmentTextExtract text from an attachment
/attachments/{attachmentId}/textextractAttachmentTextExtract text from an attachment
post/attachments/bytesuploadAttachmentBytesUpload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
/attachments/bytesuploadAttachmentBytesUpload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
post/attachments/multipartuploadMultipartFormUpload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
/attachments/multipartuploadMultipartFormUpload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
delete/attachmentsdeleteAllAttachmentsDelete all attachments
/attachmentsdeleteAllAttachmentsDelete all attachments
delete/attachments/{attachmentId}deleteAttachmentDelete an attachment
/attachments/{attachmentId}deleteAttachmentDelete an attachment
BounceController
12 endpoints
Endpoints for access to bounced emails and bounced recipients
get/bounce/account-blockgetAccountBounceBlockStatusCan account send email
/bounce/account-blockgetAccountBounceBlockStatusCan account send email
get/bounce/complaintsgetComplaintsGet paginated list of complaints.
/bounce/complaintsgetComplaintsGet paginated list of complaints.
get/bounce/complaints/{id}getComplaintGet complaint
/bounce/complaints/{id}getComplaintGet complaint
get/bounce/emailsgetBouncedEmailsGet paginated list of bounced emails.
/bounce/emailsgetBouncedEmailsGet paginated list of bounced emails.
get/bounce/emails/{id}getBouncedEmailGet a bounced email.
/bounce/emails/{id}getBouncedEmailGet a bounced email.
get/bounce/list-unsubscribe-recipientsgetListUnsubscribeRecipientsGet paginated list of unsubscribed recipients.
/bounce/list-unsubscribe-recipientsgetListUnsubscribeRecipientsGet paginated list of unsubscribed recipients.
get/bounce/recipientsgetBouncedRecipientsGet paginated list of bounced recipients.
/bounce/recipientsgetBouncedRecipientsGet paginated list of bounced recipients.
get/bounce/recipients/{id}getBouncedRecipientGet a bounced email.
/bounce/recipients/{id}getBouncedRecipientGet a bounced email.
get/bounce/reputation-itemsgetReputationItemsGet paginated list of reputation items.
/bounce/reputation-itemsgetReputationItemsGet paginated list of reputation items.
get/bounce/tenant-findingsgetTenantReputationFindingsGet SES tenant reputation findings
/bounce/tenant-findingsgetTenantReputationFindingsGet SES tenant reputation findings
get/bounce/tenant-statusgetTenantReputationStatusSummaryGet SES tenant status summary
/bounce/tenant-statusgetTenantReputationStatusSummaryGet SES tenant status summary
post/bounce/filter-recipientsfilterBouncedRecipientFilter a list of email recipients and remove those who have bounced
/bounce/filter-recipientsfilterBouncedRecipientFilter a list of email recipients and remove those who have bounced
BulkActionsController
3 endpoints
Other endpoints including advanced receive options
post/bulk/inboxesbulkCreateInboxesBulk create Inboxes (email addresses)
/bulk/inboxesbulkCreateInboxesBulk create Inboxes (email addresses)
post/bulk/sendbulkSendEmailsBulk Send Emails
/bulk/sendbulkSendEmailsBulk Send Emails
delete/bulk/inboxesbulkDeleteInboxesBulk Delete Inboxes
/bulk/inboxesbulkDeleteInboxesBulk Delete Inboxes
CampaignProbeController
10 endpoints
Create recipient probes for campaign QA, ingest sends asynchronously via SES monitor, and inspect health trends over time.
get/campaign-probe/probesgetCampaignProbesList campaign probes
/campaign-probe/probesgetCampaignProbesList campaign probes
get/campaign-probe/probes/{probeId}getCampaignProbeGet campaign probe
/campaign-probe/probes/{probeId}getCampaignProbeGet campaign probe
get/campaign-probe/probes/{probeId}/insightsgetCampaignProbeInsightsGet campaign probe insights
/campaign-probe/probes/{probeId}/insightsgetCampaignProbeInsightsGet campaign probe insights
get/campaign-probe/probes/{probeId}/runsgetCampaignProbeRunsList campaign probe runs
/campaign-probe/probes/{probeId}/runsgetCampaignProbeRunsList campaign probe runs
get/campaign-probe/probes/{probeId}/seriesgetCampaignProbeSeriesGet campaign probe trend series
/campaign-probe/probes/{probeId}/seriesgetCampaignProbeSeriesGet campaign probe trend series
post/campaign-probe/probescreateCampaignProbeCreate campaign probe
/campaign-probe/probescreateCampaignProbeCreate campaign probe
post/campaign-probe/probes/{probeId}/run-nowrunCampaignProbeNowRun campaign probe now
/campaign-probe/probes/{probeId}/run-nowrunCampaignProbeNowRun campaign probe now
post/campaign-probe/probes/run-duerunDueCampaignProbesRun due campaign probes for user
/campaign-probe/probes/run-duerunDueCampaignProbesRun due campaign probes for user
put/campaign-probe/probes/{probeId}updateCampaignProbeUpdate campaign probe
/campaign-probe/probes/{probeId}updateCampaignProbeUpdate campaign probe
delete/campaign-probe/probes/{probeId}deleteCampaignProbeDelete campaign probe
/campaign-probe/probes/{probeId}deleteCampaignProbeDelete campaign probe
CommonActionsController
6 endpoints
A collection of common actions. Groups together several controllers behind a facade with convenience methods. Not recommended. It is better in most cases to call the individual controllers directly as they are where many new features are added. The controllers are better documented too. This controller is maintained for backwards compatibility.
post/createInboxcreateRandomInboxCreate new random inbox
/createInboxcreateRandomInboxCreate new random inbox
post/newEmailAddresscreateNewEmailAddressCreate new random inbox
/newEmailAddresscreateNewEmailAddressCreate new random inbox
post/sendEmailsendEmailSimpleSend an email
/sendEmailsendEmailSimpleSend an email
post/sendEmailQuerysendEmailQuerySend an email using query parameters
/sendEmailQuerysendEmailQuerySend an email using query parameters
delete/deleteEmailAddressdeleteEmailAddressDelete inbox email address by inbox id
/deleteEmailAddressdeleteEmailAddressDelete inbox email address by inbox id
delete/emptyInboxemptyInboxDelete all emails in an inbox
/emptyInboxemptyInboxDelete all emails in an inbox
ConnectorController
31 endpoints
Endpoints for managing inbox connectors that can sync external emails in MailSlurp inboxes
get/connectorsgetConnectorsGet inbox connectors
/connectorsgetConnectorsGet inbox connectors
get/connectors/{id}getConnectorGet an inbox connector
/connectors/{id}getConnectorGet an inbox connector
get/connectors/{id}/eventsgetConnectorEventsGet an inbox connector events
/connectors/{id}/eventsgetConnectorEventsGet an inbox connector events
get/connectors/{id}/imapgetConnectorImapConnectionGet an inbox connector IMAP connection
/connectors/{id}/imapgetConnectorImapConnectionGet an inbox connector IMAP connection
get/connectors/{id}/smtpgetConnectorSmtpConnectionGet an inbox connector SMTP connection
/connectors/{id}/smtpgetConnectorSmtpConnectionGet an inbox connector SMTP connection
get/connectors/{id}/sync-settingsgetConnectorSyncSettingsGet an inbox connector sync settings
/connectors/{id}/sync-settingsgetConnectorSyncSettingsGet an inbox connector sync settings
get/connectors/by-email-addressgetConnectorByEmailAddressGet connector by email address
/connectors/by-email-addressgetConnectorByEmailAddressGet connector by email address
get/connectors/by-inbox-idgetConnectorByInboxIdGet connector by inbox ID
/connectors/by-inbox-idgetConnectorByInboxIdGet connector by inbox ID
get/connectors/by-namegetConnectorByNameGet connector by name
/connectors/by-namegetConnectorByNameGet connector by name
get/connectors/eventsgetAllConnectorEventsGet all inbox connector events
/connectors/eventsgetAllConnectorEventsGet all inbox connector events
get/connectors/events/{id}getConnectorEventGet an inbox connector event
/connectors/events/{id}getConnectorEventGet an inbox connector event
get/connectors/provider-settingsgetConnectorProviderSettingsGet SMTP and IMAP connection settings for common mail providers
/connectors/provider-settingsgetConnectorProviderSettingsGet SMTP and IMAP connection settings for common mail providers
post/connectorscreateConnectorCreate an inbox connector
/connectorscreateConnectorCreate an inbox connector
post/connectors/{id}/imapcreateConnectorImapConnectionCreate an inbox connector IMAP connection
/connectors/{id}/imapcreateConnectorImapConnectionCreate an inbox connector IMAP connection
post/connectors/{id}/imap/testtestConnectorImapConnectionTest an inbox connector IMAP connection
/connectors/{id}/imap/testtestConnectorImapConnectionTest an inbox connector IMAP connection
post/connectors/{id}/sendsendEmailFromConnectorSend from an inbox connector
/connectors/{id}/sendsendEmailFromConnectorSend from an inbox connector
post/connectors/{id}/smtpcreateConnectorSmtpConnectionCreate an inbox connector SMTP connection
/connectors/{id}/smtpcreateConnectorSmtpConnectionCreate an inbox connector SMTP connection
post/connectors/{id}/smtp/testtestConnectorSmtpConnectionTest an inbox connector SMTP connection
/connectors/{id}/smtp/testtestConnectorSmtpConnectionTest an inbox connector SMTP connection
post/connectors/{id}/syncsyncConnectorSync an inbox connector
/connectors/{id}/syncsyncConnectorSync an inbox connector
post/connectors/{id}/sync-settingscreateConnectorSyncSettingsCreate an inbox connector sync settings
/connectors/{id}/sync-settingscreateConnectorSyncSettingsCreate an inbox connector sync settings
post/connectors/connections/imap/testtestConnectorImapConnectionOptionsTest an inbox connector IMAP connection options
/connectors/connections/imap/testtestConnectorImapConnectionOptionsTest an inbox connector IMAP connection options
post/connectors/connections/smtp/testtestConnectorSmtpConnectionOptionsTest an inbox connector SMTP connection options
/connectors/connections/smtp/testtestConnectorSmtpConnectionOptionsTest an inbox connector SMTP connection options
post/connectors/withOptionscreateConnectorWithOptionsCreate an inbox connector with options
/connectors/withOptionscreateConnectorWithOptionsCreate an inbox connector with options
put/connectors/{id}updateConnectorUpdate an inbox connector
/connectors/{id}updateConnectorUpdate an inbox connector
patch/connectors/{id}/imapupdateConnectorImapConnectionUpdate an inbox connector IMAP connection
/connectors/{id}/imapupdateConnectorImapConnectionUpdate an inbox connector IMAP connection
patch/connectors/{id}/smtpupdateConnectorSmtpConnectionUpdate an inbox connector SMTP connection
/connectors/{id}/smtpupdateConnectorSmtpConnectionUpdate an inbox connector SMTP connection
delete/connectorsdeleteAllConnectorDelete all inbox connectors
/connectorsdeleteAllConnectorDelete all inbox connectors
delete/connectors/{id}deleteConnectorDelete an inbox connector
/connectors/{id}deleteConnectorDelete an inbox connector
delete/connectors/{id}/imapdeleteConnectorImapConnectionDelete an inbox connector IMAP connection
/connectors/{id}/imapdeleteConnectorImapConnectionDelete an inbox connector IMAP connection
delete/connectors/{id}/smtpdeleteConnectorSmtpConnectionDelete an inbox connector SMTP connection
/connectors/{id}/smtpdeleteConnectorSmtpConnectionDelete an inbox connector SMTP connection
delete/connectors/{id}/sync-settingsdeleteConnectorSyncSettingsCreate an inbox connector sync settings
/connectors/{id}/sync-settingsdeleteConnectorSyncSettingsCreate an inbox connector sync settings
ConsentController
4 endpoints
Endpoints for managing double opt-in consent for sending promotional material to external email accounts.
get/consent/opt-ingetOptInIdentitiesNo summary provided for this endpoint.
/consent/opt-ingetOptInIdentitiesNo summary provided for this endpoint.
get/consent/opt-in/sending-consentcheckSendingConsentForEmailAddressNo summary provided for this endpoint.
/consent/opt-in/sending-consentcheckSendingConsentForEmailAddressNo summary provided for this endpoint.
post/consent/opt-in/sendsendOptInConsentForEmailAddressSend a verification code to a user once they have explicitly submitted their email address
/consent/opt-in/sendsendOptInConsentForEmailAddressSend a verification code to a user once they have explicitly submitted their email address
delete/consent/opt-inrevokeOptInConsentForEmailAddressNo summary provided for this endpoint.
/consent/opt-inrevokeOptInConsentForEmailAddressNo summary provided for this endpoint.
ContactController
6 endpoints
Endpoints for managing contacts. Contacts can be used for sending emails to individuals and groups.
get/contactsgetContactsGet all contacts
/contactsgetContactsGet all contacts
get/contacts/{contactId}getContactGet contact
/contacts/{contactId}getContactGet contact
get/contacts/{contactId}/downloadgetContactVCardGet contact vCard vcf file
Deprecated
/contacts/{contactId}/downloadgetContactVCardGet contact vCard vcf file
get/contacts/paginatedgetAllContactsGet all contacts
/contacts/paginatedgetAllContactsGet all contacts
post/contactscreateContactCreate a contact
/contactscreateContactCreate a contact
delete/contacts/{contactId}deleteContactDelete contact
/contacts/{contactId}deleteContactDelete contact
DeliverabilityTestController
22 endpoints
Create and manage deliverability/load tests for inboxes or phone numbers. Tests evaluate expected inbound email/SMS counts over time and support polling for progress and paged entity-level results.
get/test/deliverabilitygetDeliverabilityTestsList deliverability/load tests
/test/deliverabilitygetDeliverabilityTestsList deliverability/load tests
get/test/deliverability/{testId}getDeliverabilityTestGet deliverability/load test
/test/deliverability/{testId}getDeliverabilityTestGet deliverability/load test
get/test/deliverability/{testId}/report/exportexportDeliverabilityTestReportExport deliverability/load test report as PDF
/test/deliverability/{testId}/report/exportexportDeliverabilityTestReportExport deliverability/load test report as PDF
get/test/deliverability/{testId}/resultsgetDeliverabilityTestResultsGet deliverability/load test entity results
/test/deliverability/{testId}/resultsgetDeliverabilityTestResultsGet deliverability/load test entity results
get/test/deliverability/{testId}/results/exportexportDeliverabilityTestResultsExport deliverability/load test entity results as CSV
/test/deliverability/{testId}/results/exportexportDeliverabilityTestResultsExport deliverability/load test entity results as CSV
get/test/deliverability/{testId}/simulation-jobs/{jobId}getDeliverabilitySimulationJobGet deliverability simulation job
/test/deliverability/{testId}/simulation-jobs/{jobId}getDeliverabilitySimulationJobGet deliverability simulation job
get/test/deliverability/{testId}/simulation-jobs/{jobId}/eventsgetDeliverabilitySimulationJobEventsGet deliverability simulation job events
/test/deliverability/{testId}/simulation-jobs/{jobId}/eventsgetDeliverabilitySimulationJobEventsGet deliverability simulation job events
get/test/deliverability/{testId}/simulation-jobs/latestgetLatestDeliverabilitySimulationJobGet latest deliverability simulation job
/test/deliverability/{testId}/simulation-jobs/latestgetLatestDeliverabilitySimulationJobGet latest deliverability simulation job
get/test/deliverability/{testId}/statuspollDeliverabilityTestStatusPoll deliverability/load test status
/test/deliverability/{testId}/statuspollDeliverabilityTestStatusPoll deliverability/load test status
get/test/deliverability/analytics/hotspotsgetDeliverabilityFailureHotspotsGet deliverability failure hotspots
/test/deliverability/analytics/hotspotsgetDeliverabilityFailureHotspotsGet deliverability failure hotspots
get/test/deliverability/analytics/seriesgetDeliverabilityAnalyticsSeriesGet deliverability analytics time series
/test/deliverability/analytics/seriesgetDeliverabilityAnalyticsSeriesGet deliverability analytics time series
post/test/deliverabilitycreateDeliverabilityTestCreate deliverability/load test
/test/deliverabilitycreateDeliverabilityTestCreate deliverability/load test
post/test/deliverability/{testId}/duplicateduplicateDeliverabilityTestDuplicate deliverability/load test
/test/deliverability/{testId}/duplicateduplicateDeliverabilityTestDuplicate deliverability/load test
post/test/deliverability/{testId}/pausepauseDeliverabilityTestPause deliverability/load test
/test/deliverability/{testId}/pausepauseDeliverabilityTestPause deliverability/load test
post/test/deliverability/{testId}/simulation-jobscreateDeliverabilitySimulationJobCreate deliverability simulation job
/test/deliverability/{testId}/simulation-jobscreateDeliverabilitySimulationJobCreate deliverability simulation job
post/test/deliverability/{testId}/simulation-jobs/{jobId}/cancelcancelDeliverabilitySimulationJobCancel deliverability simulation job
/test/deliverability/{testId}/simulation-jobs/{jobId}/cancelcancelDeliverabilitySimulationJobCancel deliverability simulation job
post/test/deliverability/{testId}/simulation-jobs/{jobId}/pausepauseDeliverabilitySimulationJobPause deliverability simulation job
/test/deliverability/{testId}/simulation-jobs/{jobId}/pausepauseDeliverabilitySimulationJobPause deliverability simulation job
post/test/deliverability/{testId}/simulation-jobs/{jobId}/resumeresumeDeliverabilitySimulationJobResume deliverability simulation job
/test/deliverability/{testId}/simulation-jobs/{jobId}/resumeresumeDeliverabilitySimulationJobResume deliverability simulation job
post/test/deliverability/{testId}/startstartDeliverabilityTestStart or resume deliverability/load test
/test/deliverability/{testId}/startstartDeliverabilityTestStart or resume deliverability/load test
post/test/deliverability/{testId}/stopstopDeliverabilityTestStop deliverability/load test
/test/deliverability/{testId}/stopstopDeliverabilityTestStop deliverability/load test
patch/test/deliverability/{testId}updateDeliverabilityTestUpdate deliverability/load test
/test/deliverability/{testId}updateDeliverabilityTestUpdate deliverability/load test
delete/test/deliverability/{testId}deleteDeliverabilityTestDelete deliverability/load test
/test/deliverability/{testId}deleteDeliverabilityTestDelete deliverability/load test
DevicePreviewsController
15 endpoints
Create and manage async device preview render jobs for received emails using ESP service.
get/emails/{emailId}/device-previewsgetDevicePreviewRunsList previous device preview runs for an email
/emails/{emailId}/device-previewsgetDevicePreviewRunsList previous device preview runs for an email
get/emails/{emailId}/device-previews/offset-paginatedgetDevicePreviewRunsOffsetPaginatedList previous device preview runs for an email in paginated form
/emails/{emailId}/device-previews/offset-paginatedgetDevicePreviewRunsOffsetPaginatedList previous device preview runs for an email in paginated form
get/emails/device-previewsgetDevicePreviewRunsForAccountList previous device preview runs for account
/emails/device-previewsgetDevicePreviewRunsForAccountList previous device preview runs for account
get/emails/device-previews/{runId}getDevicePreviewRunGet device preview run status
/emails/device-previews/{runId}getDevicePreviewRunGet device preview run status
get/emails/device-previews/{runId}/providers/{provider}getDevicePreviewRunProviderProgressGet provider-level progress for a device preview run
/emails/device-previews/{runId}/providers/{provider}getDevicePreviewRunProviderProgressGet provider-level progress for a device preview run
get/emails/device-previews/{runId}/resultsgetDevicePreviewRunResultsGet device preview run results
/emails/device-previews/{runId}/resultsgetDevicePreviewRunResultsGet device preview run results
get/emails/device-previews/{runId}/screenshots/{screenshotId}/imagegetDevicePreviewRunScreenshotGet a seeded device preview screenshot image
/emails/device-previews/{runId}/screenshots/{screenshotId}/imagegetDevicePreviewRunScreenshotGet a seeded device preview screenshot image
get/emails/device-previews/feedbackgetDevicePreviewFeedbackItemsList device preview feedback
/emails/device-previews/feedbackgetDevicePreviewFeedbackItemsList device preview feedback
get/emails/device-previews/feedback/{feedbackId}getDevicePreviewFeedbackGet a single device preview feedback item
/emails/device-previews/feedback/{feedbackId}getDevicePreviewFeedbackGet a single device preview feedback item
post/emails/{emailId}/device-previewscreateDevicePreviewRunCreate a new device preview run for an email
/emails/{emailId}/device-previewscreateDevicePreviewRunCreate a new device preview run for an email
post/emails/device-previews/{runId}/cancelcancelDevicePreviewRunCancel a running device preview run
/emails/device-previews/{runId}/cancelcancelDevicePreviewRunCancel a running device preview run
post/emails/device-previews/feedbackcreateDevicePreviewFeedbackCreate device preview feedback
/emails/device-previews/feedbackcreateDevicePreviewFeedbackCreate device preview feedback
put/emails/{emailId}/device-previews/latestensureDevicePreviewRunReturn active run for email or create one when none exists
/emails/{emailId}/device-previews/latestensureDevicePreviewRunReturn active run for email or create one when none exists
put/emails/device-previews/feedback/{feedbackId}updateDevicePreviewFeedbackUpdate device preview feedback
/emails/device-previews/feedback/{feedbackId}updateDevicePreviewFeedbackUpdate device preview feedback
delete/emails/device-previews/{runId}deleteDevicePreviewRunDelete local device preview run data
/emails/device-previews/{runId}deleteDevicePreviewRunDelete local device preview run data
DomainController
11 endpoints
Endpoints for managing custom domains. Once you create a custom domain you must add the returned verification records to your hosting provider. See support or guides for more information.
get/domainsgetDomainsGet domains
/domainsgetDomainsGet domains
get/domains/{id}getDomainGet a domain
/domains/{id}getDomainGet a domain
get/domains/{id}/wildcardgetDomainWildcardCatchAllInboxGet catch all wild card inbox for domain
/domains/{id}/wildcardgetDomainWildcardCatchAllInboxGet catch all wild card inbox for domain
get/domains/available-domain-regionsgetAvailableDomainRegionsGet all usable domains with account region status
/domains/available-domain-regionsgetAvailableDomainRegionsGet all usable domains with account region status
get/domains/available-domainsgetAvailableDomainsGet all usable domains
/domains/available-domainsgetAvailableDomainsGet all usable domains
get/domains/issuesgetDomainIssuesGet domain issues
/domains/issuesgetDomainIssuesGet domain issues
get/domains/mailslurp-domainsgetMailSlurpDomainsGet MailSlurp domains
/domains/mailslurp-domainsgetMailSlurpDomainsGet MailSlurp domains
post/domainscreateDomainCreate Domain
/domainscreateDomainCreate Domain
post/domains/{id}/wildcardaddDomainWildcardCatchAllAdd catch all wild card inbox to domain
/domains/{id}/wildcardaddDomainWildcardCatchAllAdd catch all wild card inbox to domain
put/domains/{id}updateDomainUpdate a domain
/domains/{id}updateDomainUpdate a domain
delete/domains/{id}deleteDomainDelete a domain
/domains/{id}deleteDomainDelete a domain
DomainMonitorController
13 endpoints
Continuously monitor domain deliverability posture with direct run-now, scheduled execution, insights, and trend analytics.
get/domain-monitor/monitorsgetDomainMonitorsList domain monitors
/domain-monitor/monitorsgetDomainMonitorsList domain monitors
get/domain-monitor/monitors/{monitorId}getDomainMonitorGet domain monitor
/domain-monitor/monitors/{monitorId}getDomainMonitorGet domain monitor
get/domain-monitor/monitors/{monitorId}/alert-sinksgetDomainMonitorAlertSinksList alert sinks for monitor
/domain-monitor/monitors/{monitorId}/alert-sinksgetDomainMonitorAlertSinksList alert sinks for monitor
get/domain-monitor/monitors/{monitorId}/insightsgetDomainMonitorInsightsGet monitor insights
/domain-monitor/monitors/{monitorId}/insightsgetDomainMonitorInsightsGet monitor insights
get/domain-monitor/monitors/{monitorId}/runsgetDomainMonitorRunsList monitor runs
/domain-monitor/monitors/{monitorId}/runsgetDomainMonitorRunsList monitor runs
get/domain-monitor/monitors/{monitorId}/seriesgetDomainMonitorSeriesGet monitor trend series
/domain-monitor/monitors/{monitorId}/seriesgetDomainMonitorSeriesGet monitor trend series
post/domain-monitor/monitorscreateDomainMonitorCreate domain monitor
/domain-monitor/monitorscreateDomainMonitorCreate domain monitor
post/domain-monitor/monitors/{monitorId}/alert-sinkscreateDomainMonitorAlertSinkCreate alert sink for monitor
/domain-monitor/monitors/{monitorId}/alert-sinkscreateDomainMonitorAlertSinkCreate alert sink for monitor
post/domain-monitor/monitors/{monitorId}/run-nowrunDomainMonitorNowRun monitor now
/domain-monitor/monitors/{monitorId}/run-nowrunDomainMonitorNowRun monitor now
post/domain-monitor/monitors/run-duerunDueDomainMonitorsRun due monitors for user
/domain-monitor/monitors/run-duerunDueDomainMonitorsRun due monitors for user
put/domain-monitor/monitors/{monitorId}updateDomainMonitorUpdate domain monitor
/domain-monitor/monitors/{monitorId}updateDomainMonitorUpdate domain monitor
delete/domain-monitor/monitors/{monitorId}deleteDomainMonitorDelete domain monitor
/domain-monitor/monitors/{monitorId}deleteDomainMonitorDelete domain monitor
delete/domain-monitor/monitors/{monitorId}/alert-sinks/{sinkId}deleteDomainMonitorAlertSinkDelete monitor alert sink
/domain-monitor/monitors/{monitorId}/alert-sinks/{sinkId}deleteDomainMonitorAlertSinkDelete monitor alert sink
EmailVerificationController
4 endpoints
get/email-verification/validation-requestsgetValidationRequestsValidate a list of email addresses. Per unit billing. See your plan for pricing.
/email-verification/validation-requestsgetValidationRequestsValidate a list of email addresses. Per unit billing. See your plan for pricing.
post/email-verification/email-address-listvalidateEmailAddressListValidate a list of email addresses. Per unit billing. See your plan for pricing.
/email-verification/email-address-listvalidateEmailAddressListValidate a list of email addresses. Per unit billing. See your plan for pricing.
delete/email-verificationdeleteAllValidationRequestsDelete all validation requests
/email-verificationdeleteAllValidationRequestsDelete all validation requests
delete/email-verification/{id}deleteValidationRequestDelete a validation record
/email-verification/{id}deleteValidationRequestDelete a validation record
ExpiredController
4 endpoints
View and manage expired inbox records. If an inbox has an expiration date when it is created it will expire at that time and an ExpiredInboxRecord will be created for it listing the email address and inbox ID. You can still view emails belonging to the inbox by using the inbox ID but the inbox can no longer send or receive emails once expired.
get/expiredgetExpiredInboxesList records of expired inboxes
/expiredgetExpiredInboxesList records of expired inboxes
get/expired/{expiredId}getExpiredInboxRecordGet an expired inbox record
/expired/{expiredId}getExpiredInboxRecordGet an expired inbox record
get/expired/defaultsgetExpirationDefaultsGet default expiration settings
/expired/defaultsgetExpirationDefaultsGet default expiration settings
get/expired/inbox/{inboxId}getExpiredInboxByInboxIdGet expired inbox record for a previously existing inbox
/expired/inbox/{inboxId}getExpiredInboxByInboxIdGet expired inbox record for a previously existing inbox
ExportController
2 endpoints
Endpoints for exporting user data to CSV, XML and other formats.
get/exportexportEntitiesExport inboxes link callable via browser
/exportexportEntitiesExport inboxes link callable via browser
post/exportgetExportLinkGet export link
/exportgetExportLinkGet export link
FormController
1 endpoint
Form controller for submitting email-able forms
post/formssubmitFormSubmit a form to be parsed and sent as an email to an address determined by the form fields
/formssubmitFormSubmit a form to be parsed and sent as an email to an address determined by the form fields
GroupController
9 endpoints
Endpoints for managing groups. Groups can be used for sending emails to individuals and groups.
get/groupsgetGroupsGet all groups
/groupsgetGroupsGet all groups
get/groups/{groupId}getGroupGet group
/groups/{groupId}getGroupGet group
get/groups/{groupId}/contactsgetGroupWithContactsGet group and contacts belonging to it
/groups/{groupId}/contactsgetGroupWithContactsGet group and contacts belonging to it
get/groups/{groupId}/contacts-paginatedgetGroupWithContactsPaginatedGet group and paginated contacts belonging to it
/groups/{groupId}/contacts-paginatedgetGroupWithContactsPaginatedGet group and paginated contacts belonging to it
get/groups/paginatedgetAllGroupsGet all Contact Groups in paginated format
/groups/paginatedgetAllGroupsGet all Contact Groups in paginated format
post/groupscreateGroupCreate a group
/groupscreateGroupCreate a group
put/groups/{groupId}/contactsaddContactsToGroupAdd contacts to a group
/groups/{groupId}/contactsaddContactsToGroupAdd contacts to a group
delete/groups/{groupId}deleteGroupDelete group
/groups/{groupId}deleteGroupDelete group
delete/groups/{groupId}/contactsremoveContactsFromGroupRemove contacts from a group
/groups/{groupId}/contactsremoveContactsFromGroupRemove contacts from a group
GuestPortalController
8 endpoints
"Endpoints for managing guest portals and customer access to shareable email accounts. Use portals to grant your customers access to unique email accounts with a separate login and viewing endpoint.
get/guest-portalgetGuestPortalsGet guest portals
/guest-portalgetGuestPortalsGet guest portals
get/guest-portal/{portalId}getGuestPortalGet a client email portal
/guest-portal/{portalId}getGuestPortalGet a client email portal
get/guest-portal/{portalId}/usergetGuestPortalUsersGet all guest users for portal
/guest-portal/{portalId}/usergetGuestPortalUsersGet all guest users for portal
get/guest-portal/{portalId}/user/{guestId}getGuestPortalUserGet guest user for portal
/guest-portal/{portalId}/user/{guestId}getGuestPortalUserGet guest user for portal
get/guest-portal/usergetAllGuestPortalUsersGet all guest users for portal
/guest-portal/usergetAllGuestPortalUsersGet all guest users for portal
get/guest-portal/user/{guestId}getGuestPortalUserByIdGet guest user
/guest-portal/user/{guestId}getGuestPortalUserByIdGet guest user
post/guest-portalcreateGuestPortalCreate a portal page for your customers or clients to log into email accounts and view emails.
/guest-portalcreateGuestPortalCreate a portal page for your customers or clients to log into email accounts and view emails.
post/guest-portal/{portalId}/usercreateGuestPortalUserCreate a portal guest user
/guest-portal/{portalId}/usercreateGuestPortalUserCreate a portal guest user
ImapController
7 endpoints
Endpoints for performing IMAP like commands on inboxes
post/imap/server/fetchimapServerFetchFetch message in an inbox
/imap/server/fetchimapServerFetchFetch message in an inbox
post/imap/server/getimapServerGetGet a message by email ID
/imap/server/getimapServerGetGet a message by email ID
post/imap/server/listimapServerListList messages in an inbox
/imap/server/listimapServerListList messages in an inbox
post/imap/server/mailboximapServerMailboxCreate a new mailbox if possible
/imap/server/mailboximapServerMailboxCreate a new mailbox if possible
post/imap/server/searchimapServerSearchSearch messages in an inbox
/imap/server/searchimapServerSearchSearch messages in an inbox
post/imap/server/statusimapServerStatusGet status for mailbox
/imap/server/statusimapServerStatusGet status for mailbox
post/imap/server/update-flagsimapServerUpdateFlagsUpdate message flags
/imap/server/update-flagsimapServerUpdateFlagsUpdate message flags
InboxForwarderController
13 endpoints
Endpoints for creating and managing inbox forwarders. Automatically forward emails received by inboxes using rules.
get/forwardersgetInboxForwardersList inbox forwarders
/forwardersgetInboxForwardersList inbox forwarders
get/forwarders/{id}getInboxForwarderGet an inbox forwarder
/forwarders/{id}getInboxForwarderGet an inbox forwarder
get/forwarders/{id}/eventsgetInboxForwarderEventsGet an inbox forwarder event list
/forwarders/{id}/eventsgetInboxForwarderEventsGet an inbox forwarder event list
get/forwarders/{id}/events/{eventId}getInboxForwarderEventGet an inbox forwarder event
/forwarders/{id}/events/{eventId}getInboxForwarderEventGet an inbox forwarder event
get/forwarders/eventsgetAllInboxForwarderEventsGet all inbox forwarder events
/forwarders/eventsgetAllInboxForwarderEventsGet all inbox forwarder events
get/forwarders/events/{eventId}getForwarderEventGet a forwarder event
/forwarders/events/{eventId}getForwarderEventGet a forwarder event
post/forwarderscreateNewInboxForwarderCreate an inbox forwarder
/forwarderscreateNewInboxForwarderCreate an inbox forwarder
post/forwarders/{id}/testtestInboxForwarderTest an inbox forwarder
/forwarders/{id}/testtestInboxForwarderTest an inbox forwarder
put/forwarderstestInboxForwardersForInboxTest inbox forwarders for inbox
/forwarderstestInboxForwardersForInboxTest inbox forwarders for inbox
put/forwarders/{id}updateInboxForwarderUpdate an inbox forwarder
/forwarders/{id}updateInboxForwarderUpdate an inbox forwarder
patch/forwarderstestNewInboxForwarderTest new inbox forwarder
/forwarderstestNewInboxForwarderTest new inbox forwarder
delete/forwardersdeleteInboxForwardersDelete inbox forwarders
/forwardersdeleteInboxForwardersDelete inbox forwarders
delete/forwarders/{id}deleteInboxForwarderDelete an inbox forwarder
/forwarders/{id}deleteInboxForwarderDelete an inbox forwarder
InboxReplierController
8 endpoints
Endpoints for creating and managing inbox repliers. Repliers can automatically reply to emails received by inboxes using rules.
get/repliersgetInboxRepliersList inbox repliers
/repliersgetInboxRepliersList inbox repliers
get/repliers/{id}getInboxReplierGet an inbox replier
/repliers/{id}getInboxReplierGet an inbox replier
get/repliers/{id}/eventsgetInboxReplierEventsGet an inbox replier event list
/repliers/{id}/eventsgetInboxReplierEventsGet an inbox replier event list
get/repliers/eventsgetAllInboxReplierEventsGet inbox replier event list
/repliers/eventsgetAllInboxReplierEventsGet inbox replier event list
post/replierscreateNewInboxReplierCreate an inbox replier
/replierscreateNewInboxReplierCreate an inbox replier
put/repliers/{id}updateInboxReplierUpdate an inbox replier
/repliers/{id}updateInboxReplierUpdate an inbox replier
delete/repliersdeleteInboxRepliersDelete inbox repliers
/repliersdeleteInboxRepliersDelete inbox repliers
delete/repliers/{id}deleteInboxReplierDelete an inbox replier
/repliers/{id}deleteInboxReplierDelete an inbox replier
MailServerController
5 endpoints
post/mail-server/describe/dns-lookupgetDnsLookupLookup DNS records for a domain
/mail-server/describe/dns-lookupgetDnsLookupLookup DNS records for a domain
post/mail-server/describe/dns-lookupsgetDnsLookupsLookup DNS records for multiple domains
/mail-server/describe/dns-lookupsgetDnsLookupsLookup DNS records for multiple domains
post/mail-server/describe/domaindescribeMailServerDomainGet DNS Mail Server records for a domain
/mail-server/describe/domaindescribeMailServerDomainGet DNS Mail Server records for a domain
post/mail-server/describe/ip-addressgetIpAddressGet IP address for a domain
/mail-server/describe/ip-addressgetIpAddressGet IP address for a domain
post/mail-server/verify/email-addressverifyEmailAddressDeprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
Deprecated
/mail-server/verify/email-addressverifyEmailAddressDeprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
MFAController
6 endpoints
Multi-factor authentication (MFA) endpoints for MailSlurp. For controlling virtual TOTP devices..
get/mfa/totp/device/{id}getTotpDeviceGet a TOTP device by ID
/mfa/totp/device/{id}getTotpDeviceGet a TOTP device by ID
get/mfa/totp/device/{id}/codegetTotpDeviceCodeGet a TOTP device code by device ID
/mfa/totp/device/{id}/codegetTotpDeviceCodeGet a TOTP device code by device ID
get/mfa/totp/device/bygetTotpDeviceByGet a TOTP device by username, issuer, or name. Returns empty if not found.
/mfa/totp/device/bygetTotpDeviceByGet a TOTP device by username, issuer, or name. Returns empty if not found.
post/mfa/totp/device/base32SecretKeycreateTotpDeviceForBase32SecretKeyCreate a TOTP device from an base32 secret key
/mfa/totp/device/base32SecretKeycreateTotpDeviceForBase32SecretKeyCreate a TOTP device from an base32 secret key
post/mfa/totp/device/customcreateTotpDeviceForCustomCreate a TOTP device from custom options
/mfa/totp/device/customcreateTotpDeviceForCustomCreate a TOTP device from custom options
post/mfa/totp/device/otpAuthUrlcreateTotpDeviceForOtpAuthUrlCreate a TOTP device from an OTP Auth URL
/mfa/totp/device/otpAuthUrlcreateTotpDeviceForOtpAuthUrlCreate a TOTP device from an OTP Auth URL
MissedEmailController
5 endpoints
Endpoints for managing MissedEmails. Missed emails are saved whenever your account cannot persist a received email because your plan had exceeded a given usage at the time. Missed emails can be restored with the assistance of the support team.
get/missed-emailsgetAllMissedEmailsGet all MissedEmails in paginated format
/missed-emailsgetAllMissedEmailsGet all MissedEmails in paginated format
get/missed-emails/{missedEmailId}getMissedEmailGet MissedEmail
/missed-emails/{missedEmailId}getMissedEmailGet MissedEmail
get/missed-emails/unknowngetAllUnknownMissedEmailsGet all unknown missed emails in paginated format
/missed-emails/unknowngetAllUnknownMissedEmailsGet all unknown missed emails in paginated format
get/missed-emails/waitForNthMissedEmailwaitForNthMissedEmailWait for Nth missed email
/missed-emails/waitForNthMissedEmailwaitForNthMissedEmailWait for Nth missed email
post/missed-emails/restorerestoreMissedEmailsRestore missed emails
/missed-emails/restorerestoreMissedEmailsRestore missed emails
MissedSmsController
3 endpoints
Endpoints for managing missed SMS. Missed SMS records are created when inbound SMS cannot be persisted after receipt.
get/missed-smsgetAllMissedSmsMessagesGet all missed SMS messages in paginated format
/missed-smsgetAllMissedSmsMessagesGet all missed SMS messages in paginated format
get/missed-sms/{missedSmsId}getMissedSmsMessageGet missed SMS content
/missed-sms/{missedSmsId}getMissedSmsMessageGet missed SMS content
get/missed-sms/countgetMissedSmsCountGet missed SMS count
/missed-sms/countgetMissedSmsCountGet missed SMS count
RulesetController
10 endpoints
Endpoints for creating and managing inbox rulesets. Inbox rulesets are sets of rules that can be automatically applied to inbound and outbound emails for an inbox. Rulesets can have a scope, action, and target. The scope is receiving or sending emails. The action is to block, allow, or forward an email. The target is pattern or email address depending on the action. The handler can be used to handle rules silently or trigger an exception when they occur. See inbox controller for similar methods.
get/rulesetsgetRulesetsList rulesets block and allow lists
/rulesetsgetRulesetsList rulesets block and allow lists
get/rulesets/{id}getRulesetGet a ruleset
/rulesets/{id}getRulesetGet a ruleset
post/rulesetscreateNewRulesetCreate a ruleset
/rulesetscreateNewRulesetCreate a ruleset
post/rulesets/{id}/testtestRulesetTest a ruleset
/rulesets/{id}/testtestRulesetTest a ruleset
post/rulesets/test-receivingtestRulesetReceivingTest receiving with rulesets
/rulesets/test-receivingtestRulesetReceivingTest receiving with rulesets
post/rulesets/test-sendingtestRulesetSendingTest sending with rulesets
/rulesets/test-sendingtestRulesetSendingTest sending with rulesets
put/rulesetstestInboxRulesetsForInboxTest inbox rulesets for inbox
/rulesetstestInboxRulesetsForInboxTest inbox rulesets for inbox
patch/rulesetstestNewRulesetTest new ruleset
/rulesetstestNewRulesetTest new ruleset
delete/rulesetsdeleteRulesetsDelete rulesets
/rulesetsdeleteRulesetsDelete rulesets
delete/rulesets/{id}deleteRulesetDelete a ruleset
/rulesets/{id}deleteRulesetDelete a ruleset
SentEmailsController
16 endpoints
Endpoints for viewing sent email receipts. These can be used to verify that an email has been sent or for historical records. Email content and attachments are stored. For legacy reasons the default send endpoint does not return a sent email. Use the `sendEmailAndConfirm` methods to receive a sent email receipt after sending.
get/sentgetSentEmailsGet all sent emails in paginated form
/sentgetSentEmailsGet all sent emails in paginated form
get/sent/{emailId}/rawgetRawSentEmailContentsGet raw sent email string. Returns unparsed raw SMTP message with headers and body.
/sent/{emailId}/rawgetRawSentEmailContentsGet raw sent email string. Returns unparsed raw SMTP message with headers and body.
get/sent/{emailId}/raw/jsongetRawSentEmailJsonGet raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
/sent/{emailId}/raw/jsongetRawSentEmailJsonGet raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
get/sent/{id}getSentEmailGet sent email receipt
/sent/{id}getSentEmailGet sent email receipt
get/sent/{id}/htmlgetSentEmailHTMLContentGet sent email HTML content
/sent/{id}/htmlgetSentEmailHTMLContentGet sent email HTML content
get/sent/{id}/tracking-pixelsgetSentEmailTrackingPixelsGet all tracking pixels for a sent email in paginated form
/sent/{id}/tracking-pixelsgetSentEmailTrackingPixelsGet all tracking pixels for a sent email in paginated form
get/sent/{id}/urlsgetSentEmailPreviewURLsGet sent email URL for viewing in browser or downloading
/sent/{id}/urlsgetSentEmailPreviewURLsGet sent email URL for viewing in browser or downloading
get/sent/{sentId}/delivery-statusgetSentDeliveryStatusesBySentIdGet all sent email delivery statuses
/sent/{sentId}/delivery-statusgetSentDeliveryStatusesBySentIdGet all sent email delivery statuses
get/sent/delivery-statusgetSentDeliveryStatusesGet all sent email delivery statuses
/sent/delivery-statusgetSentDeliveryStatusesGet all sent email delivery statuses
get/sent/delivery-status/{deliveryId}getSentDeliveryStatusGet a sent email delivery status
/sent/delivery-status/{deliveryId}getSentDeliveryStatusGet a sent email delivery status
get/sent/delivery-status/wait-forwaitForDeliveryStatusesWait for delivery statuses
/sent/delivery-status/wait-forwaitForDeliveryStatusesWait for delivery statuses
get/sent/organizationgetSentOrganizationEmailsGet all sent organization emails in paginated form
/sent/organizationgetSentOrganizationEmailsGet all sent organization emails in paginated form
get/sent/queue-resultsgetSentEmailsWithQueueResultsGet results of email sent with queues in paginated form
/sent/queue-resultsgetSentEmailsWithQueueResultsGet results of email sent with queues in paginated form
get/sent/tracking-pixelsgetAllSentTrackingPixelsGet all sent email tracking pixels in paginated form
/sent/tracking-pixelsgetAllSentTrackingPixelsGet all sent email tracking pixels in paginated form
delete/sentdeleteAllSentEmailsDelete all sent email receipts
/sentdeleteAllSentEmailsDelete all sent email receipts
delete/sent/{id}deleteSentEmailDelete sent email receipt
/sent/{id}deleteSentEmailDelete sent email receipt
TemplateController
8 endpoints
Endpoints for managing Templates. Templates can be used when sending emails and support moustache syntax template variables. Variables can be passed with send email options or implicitly available if Contact Groups are used.
get/templatesgetTemplatesList templates
/templatesgetTemplatesList templates
get/templates/{templateId}getTemplateGet template
/templates/{templateId}getTemplateGet template
get/templates/{templateId}/preview/htmlgetTemplatePreviewHtmlGet template preview HTML
/templates/{templateId}/preview/htmlgetTemplatePreviewHtmlGet template preview HTML
get/templates/{templateId}/preview/jsongetTemplatePreviewJsonGet template preview Json
/templates/{templateId}/preview/jsongetTemplatePreviewJsonGet template preview Json
get/templates/paginatedgetAllTemplatesList templates
/templates/paginatedgetAllTemplatesList templates
post/templatescreateTemplateCreate a Template
/templatescreateTemplateCreate a Template
put/templates/{templateId}updateTemplateUpdate template
/templates/{templateId}updateTemplateUpdate template
delete/templates/{templateId}deleteTemplateDelete email template
/templates/{templateId}deleteTemplateDelete email template
ToolsController
16 endpoints
Endpoints for miscellaneous tools.
get/tools/fake-emailgetFakeEmailByIdGet a fake email by its ID
/tools/fake-emailgetFakeEmailByIdGet a fake email by its ID
get/tools/fake-email/byEmailAddressgetFakeEmailByEmailAddressNo summary provided for this endpoint.
/tools/fake-email/byEmailAddressgetFakeEmailByEmailAddressNo summary provided for this endpoint.
get/tools/fake-email/htmlgetFakeEmailRawGet raw fake email content
/tools/fake-email/htmlgetFakeEmailRawGet raw fake email content
get/tools/fake-emailsgetFakeEmailsForAddressGet fake emails for an address
/tools/fake-emailsgetFakeEmailsForAddressGet fake emails for an address
post/tools/check-email-features-client-supportcheckEmailFeaturesClientSupportCheck email client support for email HTML and CSS features
/tools/check-email-features-client-supportcheckEmailFeaturesClientSupportCheck email client support for email HTML and CSS features
post/tools/fake-emailcreateNewFakeEmailAddressCreate a new email address using the fake email domains
/tools/fake-emailcreateNewFakeEmailAddressCreate a new email address using the fake email domains
post/tools/generate-bimi-recordgenerateBimiRecordCreate a BIMI record policy
/tools/generate-bimi-recordgenerateBimiRecordCreate a BIMI record policy
post/tools/generate-dmarc-recordgenerateDmarcRecordCreate a DMARC record policy
/tools/generate-dmarc-recordgenerateDmarcRecordCreate a DMARC record policy
post/tools/generate-mta-sts-recordgenerateMtaStsRecordCreate a TLS reporting record policy
/tools/generate-mta-sts-recordgenerateMtaStsRecordCreate a TLS reporting record policy
post/tools/generate-tls-reporting-recordgenerateTlsReportingRecordCreate a TLS reporting record policy
/tools/generate-tls-reporting-recordgenerateTlsReportingRecordCreate a TLS reporting record policy
post/tools/lookup-bimi-domainlookupBimiDomainLookup a BIMI record policy
/tools/lookup-bimi-domainlookupBimiDomainLookup a BIMI record policy
post/tools/lookup-dmarc-domainlookupDmarcDomainLookup a DMARC record policy
/tools/lookup-dmarc-domainlookupDmarcDomainLookup a DMARC record policy
post/tools/lookup-mta-sts-domainlookupMtaStsDomainLookup a MTA-STS domain policy
/tools/lookup-mta-sts-domainlookupMtaStsDomainLookup a MTA-STS domain policy
post/tools/lookup-mx-recordslookupMxRecordLookup a MX records for a domain
/tools/lookup-mx-recordslookupMxRecordLookup a MX records for a domain
post/tools/lookup-tls-reporting-domainlookupTlsReportingDomainLookup a TLS reporting domain policy
/tools/lookup-tls-reporting-domainlookupTlsReportingDomainLookup a TLS reporting domain policy
delete/tools/fake-emaildeleteNewFakeEmailAddressDelete a fake email address using the fake email domains
/tools/fake-emaildeleteNewFakeEmailAddressDelete a fake email address using the fake email domains
TrackingController
3 endpoints
Endpoints for managing tracking entities such as email open and read tracking pixels.
get/tracking/pixelsgetAllTrackingPixelsGet tracking pixels
/tracking/pixelsgetAllTrackingPixelsGet tracking pixels
get/tracking/pixels/{id}getTrackingPixelGet pixel
/tracking/pixels/{id}getTrackingPixelGet pixel
post/tracking/pixelscreateTrackingPixelCreate tracking pixel
/tracking/pixelscreateTrackingPixelCreate tracking pixel
UserController
8 endpoints
get/user/automationsgetEntityAutomationsNo summary provided for this endpoint.
/user/automationsgetEntityAutomationsNo summary provided for this endpoint.
get/user/eventsgetEntityEventsNo summary provided for this endpoint.
/user/eventsgetEntityEventsNo summary provided for this endpoint.
get/user/favoritesgetEntityFavoritesNo summary provided for this endpoint.
/user/favoritesgetEntityFavoritesNo summary provided for this endpoint.
get/user/inbox-retention-policies/accountgetInboxRetentionPolicyForAccountGet inbox retention policy for your global account
/user/inbox-retention-policies/accountgetInboxRetentionPolicyForAccountGet inbox retention policy for your global account
get/user/infogetUserInfoGet account information for your user
/user/infogetUserInfoGet account information for your user
post/user/inbox-retention-policies/accountcreateOrUpdateInboxRetentionPolicyForAccountCreate inbox retention policy for your global account
/user/inbox-retention-policies/accountcreateOrUpdateInboxRetentionPolicyForAccountCreate inbox retention policy for your global account
post/user/json/pluckgetJsonPropertyAsStringUtility function to extract properties from JSON objects in language where this is cumbersome.
/user/json/pluckgetJsonPropertyAsStringUtility function to extract properties from JSON objects in language where this is cumbersome.
delete/user/inbox-retention-policies/accountdeleteInboxRetentionPolicyForAccountDelete inbox retention policy for your global account
/user/inbox-retention-policies/accountdeleteInboxRetentionPolicyForAccountDelete inbox retention policy for your global account
WaitForController
8 endpoints
Endpoints for receiving emails using waitFor methods. The endpoints are perfect for synchronous blocking calls, long-polling, or tests (see webhooks if you need to respond to email events as they happen using HTTP notification). These wait endpoints are all built around a common idea - that you ask for an expected number of emails from an inbox and MailSlurp will either: A) Return the matching emails if they are present; B) Hold a connection open until the matching emails are are received or until a timeout occurs. For test suites we recommend that you create a new inbox for each test run and use the waitForLatestEmail to hold the connection until the email you expect arrives. Note if your inbox is not already empty waitFor methods may return immediately depending on their implementation. See each endpoint for more details.
get/waitForEmailCountwaitForEmailCountWait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
/waitForEmailCountwaitForEmailCountWait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
get/waitForLatestEmailwaitForLatestEmailFetch inbox's latest email or if empty wait for an email to arrive
/waitForLatestEmailwaitForLatestEmailFetch inbox's latest email or if empty wait for an email to arrive
get/waitForNthEmailwaitForNthEmailWait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur.
/waitForNthEmailwaitForNthEmailWait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur.
post/waitForwaitForWait for an email to match the provided filter conditions such as subject contains keyword.
/waitForwaitForWait for an email to match the provided filter conditions such as subject contains keyword.
post/waitForLatestSmswaitForLatestSmsWait for the latest SMS message to match the provided filter conditions such as body contains keyword.
/waitForLatestSmswaitForLatestSmsWait for the latest SMS message to match the provided filter conditions such as body contains keyword.
post/waitForMatchingEmailswaitForMatchingEmailsWait or return list of emails that match simple matching patterns
/waitForMatchingEmailswaitForMatchingEmailsWait or return list of emails that match simple matching patterns
post/waitForMatchingFirstEmailwaitForMatchingFirstEmailWait for or return the first email that matches provided MatchOptions array
/waitForMatchingFirstEmailwaitForMatchingFirstEmailWait for or return the first email that matches provided MatchOptions array
post/waitForSmswaitForSmsWait for an SMS message to match the provided filter conditions such as body contains keyword.
/waitForSmswaitForSmsWait for an SMS message to match the provided filter conditions such as body contains keyword.
WebhookController
40 endpoints
Endpoint for interacting with webhooks. Webhooks have a URL that points to your server. Useful for email forwarding, email API processing and more. They can be added to inboxes and when an inbox receives an email the email ID and inbox ID will be posted to the URL endpoint at your server. The schema of the webhook payload is available at https://api.mailslurp.com/schemas/webhook-payload or by calling https://api.mailslurp.com/webhooks/test. Use webhooks to react in real-time to inbound emails. Use the webhook payload posted to your server to fetch the full emails or attachments if you need them. Use the event ID as an idempotent record. The ID identifies the webhook payload uniquely. MailSlurp tracks webhook processing. It will try not to send the same event twice but it can happen. If you receive the same event more than once you can ignore it and assume it is the same. It is recommended that you use a store or database to track webhooks you have processed to avoid processing events more than once.
get/inboxes/{inboxId}/webhooksgetWebhooksGet all webhooks for an Inbox
Deprecated
/inboxes/{inboxId}/webhooksgetWebhooksGet all webhooks for an Inbox
get/inboxes/{inboxId}/webhooks/paginatedgetInboxWebhooksPaginatedGet paginated webhooks for an Inbox
/inboxes/{inboxId}/webhooks/paginatedgetInboxWebhooksPaginatedGet paginated webhooks for an Inbox
get/phone/numbers/{phoneId}/webhooks/paginatedgetPhoneNumberWebhooksPaginatedGet paginated webhooks for a phone number
/phone/numbers/{phoneId}/webhooks/paginatedgetPhoneNumberWebhooksPaginatedGet paginated webhooks for a phone number
get/webhooks/{webhookId}getWebhookGet a webhook
/webhooks/{webhookId}getWebhookGet a webhook
get/webhooks/{webhookId}/resultsgetWebhookResultsGet a webhook results for a webhook
/webhooks/{webhookId}/resultsgetWebhookResultsGet a webhook results for a webhook
get/webhooks/{webhookId}/results/countgetWebhookResultsCountGet a webhook results count for a webhook
/webhooks/{webhookId}/results/countgetWebhookResultsCountGet a webhook results count for a webhook
get/webhooks/{webhookId}/waitwaitForWebhookResultsWait for webhook results for a webhook
/webhooks/{webhookId}/waitwaitForWebhookResultsWait for webhook results for a webhook
get/webhooks/account/paginatedgetAllAccountWebhooksList account webhooks Paginated
/webhooks/account/paginatedgetAllAccountWebhooksList account webhooks Paginated
get/webhooks/endpointsgetAllWebhookEndpointsList Webhooks endpoints Paginated
/webhooks/endpointsgetAllWebhookEndpointsList Webhooks endpoints Paginated
get/webhooks/paginatedgetAllWebhooksList Webhooks Paginated
/webhooks/paginatedgetAllWebhooksList Webhooks Paginated
get/webhooks/resultsgetAllWebhookResultsGet results for all webhooks
/webhooks/resultsgetAllWebhookResultsGet results for all webhooks
get/webhooks/results/{webhookResultId}getWebhookResultGet a webhook result for a webhook
/webhooks/results/{webhookResultId}getWebhookResultGet a webhook result for a webhook
get/webhooks/results/unseen-countgetWebhookResultsUnseenErrorCountGet count of unseen webhook results with error status
/webhooks/results/unseen-countgetWebhookResultsUnseenErrorCountGet count of unseen webhook results with error status
get/webhooks/testgetTestWebhookPayloadGet test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.
/webhooks/testgetTestWebhookPayloadGet test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.
get/webhooks/test/delivery-status-payloadgetTestWebhookPayloadDeliveryStatusGet webhook test payload for delivery status event
/webhooks/test/delivery-status-payloadgetTestWebhookPayloadDeliveryStatusGet webhook test payload for delivery status event
get/webhooks/test/email-bounce-payloadgetTestWebhookPayloadBounceGet webhook test payload for bounce
/webhooks/test/email-bounce-payloadgetTestWebhookPayloadBounceGet webhook test payload for bounce
get/webhooks/test/email-bounce-recipient-payloadgetTestWebhookPayloadBounceRecipientGet webhook test payload for bounce recipient
/webhooks/test/email-bounce-recipient-payloadgetTestWebhookPayloadBounceRecipientGet webhook test payload for bounce recipient
get/webhooks/test/email-opened-payloadgetTestWebhookPayloadEmailOpenedGet webhook test payload for email opened event
/webhooks/test/email-opened-payloadgetTestWebhookPayloadEmailOpenedGet webhook test payload for email opened event
get/webhooks/test/email-read-payloadgetTestWebhookPayloadEmailReadGet webhook test payload for email opened event
/webhooks/test/email-read-payloadgetTestWebhookPayloadEmailReadGet webhook test payload for email opened event
get/webhooks/test/new-ai-transform-result-payloadgetTestWebhookPayloadNewAITransformResultGet webhook test payload for new ai transform result event
/webhooks/test/new-ai-transform-result-payloadgetTestWebhookPayloadNewAITransformResultGet webhook test payload for new ai transform result event
get/webhooks/test/new-attachment-payloadgetTestWebhookPayloadNewAttachmentGet webhook test payload for new attachment event
/webhooks/test/new-attachment-payloadgetTestWebhookPayloadNewAttachmentGet webhook test payload for new attachment event
get/webhooks/test/new-contact-payloadgetTestWebhookPayloadNewContactGet webhook test payload for new contact event
/webhooks/test/new-contact-payloadgetTestWebhookPayloadNewContactGet webhook test payload for new contact event
get/webhooks/test/new-email-payloadgetTestWebhookPayloadNewEmailGet webhook test payload for new email event
/webhooks/test/new-email-payloadgetTestWebhookPayloadNewEmailGet webhook test payload for new email event
get/webhooks/test/new-sms-payloadgetTestWebhookPayloadNewSmsGet webhook test payload for new sms event
/webhooks/test/new-sms-payloadgetTestWebhookPayloadNewSmsGet webhook test payload for new sms event
post/ai-transformers/{transformerId}/webhookscreateWebhookForAITransformerAttach a WebHook URL to an AI transformer
/ai-transformers/{transformerId}/webhookscreateWebhookForAITransformerAttach a WebHook URL to an AI transformer
post/inboxes/{inboxId}/webhookscreateWebhookAttach a WebHook URL to an inbox
/inboxes/{inboxId}/webhookscreateWebhookAttach a WebHook URL to an inbox
post/phone/numbers/{phoneNumberId}/webhookscreateWebhookForPhoneNumberAttach a WebHook URL to a phone number
/phone/numbers/{phoneNumberId}/webhookscreateWebhookForPhoneNumberAttach a WebHook URL to a phone number
post/webhookscreateAccountWebhookAttach a WebHook URL to an inbox
/webhookscreateAccountWebhookAttach a WebHook URL to an inbox
post/webhooks/{webhookId}/examplegetTestWebhookPayloadForWebhookGet example payload for webhook
/webhooks/{webhookId}/examplegetTestWebhookPayloadForWebhookGet example payload for webhook
post/webhooks/{webhookId}/schemagetJsonSchemaForWebhookPayloadGet JSON Schema definition for webhook payload
/webhooks/{webhookId}/schemagetJsonSchemaForWebhookPayloadGet JSON Schema definition for webhook payload
post/webhooks/{webhookId}/testsendTestDataSend webhook test data
/webhooks/{webhookId}/testsendTestDataSend webhook test data
post/webhooks/results/{webhookResultId}/redriveredriveWebhookResultGet a webhook result and try to resend the original webhook payload
/webhooks/results/{webhookResultId}/redriveredriveWebhookResultGet a webhook result and try to resend the original webhook payload
post/webhooks/results/redriveredriveAllWebhookResultsRedrive all webhook results that have failed status
/webhooks/results/redriveredriveAllWebhookResultsRedrive all webhook results that have failed status
post/webhooks/schemagetJsonSchemaForWebhookEventGet JSON Schema definition for webhook payload by event
/webhooks/schemagetJsonSchemaForWebhookEventGet JSON Schema definition for webhook payload by event
post/webhooks/verifyverifyWebhookSignatureVerify a webhook payload signature
/webhooks/verifyverifyWebhookSignatureVerify a webhook payload signature
put/webhooks/{webhookId}/headersupdateWebhookHeadersUpdate a webhook request headers
/webhooks/{webhookId}/headersupdateWebhookHeadersUpdate a webhook request headers
patch/webhooks/{webhookId}updateWebhookUpdate a webhook
/webhooks/{webhookId}updateWebhookUpdate a webhook
delete/inboxes/{inboxId}/webhooks/{webhookId}deleteWebhookDelete and disable a Webhook for an Inbox
/inboxes/{inboxId}/webhooks/{webhookId}deleteWebhookDelete and disable a Webhook for an Inbox
delete/webhooksdeleteAllWebhooksDelete all webhooks
/webhooksdeleteAllWebhooksDelete all webhooks
delete/webhooks/{webhookId}deleteWebhookByIdDelete a webhook
/webhooks/{webhookId}deleteWebhookByIdDelete a webhook