Bulk
Send one broadcast message to many recipients and track the progress of the request. Requires Bulk API approval from Postmark support.
List bulk API requests
Returns the bulk requests submitted on the current server, newest first. Page through results by passing the returned PaginationKey back unchanged as paginationKey. Requires Bulk API approval.
query Parameters
countNumber of requests to return per page.
paginationKeyOpaque cursor from the previous response's PaginationKey. Do not decode, modify or construct it; an altered value yields error code 13.
List bulk API requests › Responses
A page of bulk request statuses.
Bulk requests submitted on this server, newest first.
PaginationKeyOpaque cursor for the next page. Pass it back unchanged as paginationKey. Absent on the last page.
Send bulk emails
Sends one message to many recipients on a broadcast stream. Define the content (and attachments) once and personalize per recipient with TemplateModel. Postmark releases messages at a rate optimized for deliverability.
Requires approval: the Bulk API must be enabled on your account (contact Postmark support); otherwise the call fails with error code 14.
If any message has a malformed field (for example an invalid address) the whole request is rejected with 422 and nothing is processed. Well-formed but undeliverable messages (suppressed recipients, failed template renders) are accepted and reported through FailedCount.
Send bulk emails › Request Body
FromSender email address. Must belong to a confirmed Sender Signature.
Recipients and their per-message data.
ReplyToReply-To override.
SubjectEmail subject. May contain template variables.
HtmlBodyHTML body. Required if no TextBody or template is given.
TextBodyPlain-text body. Required if no HtmlBody or template is given.
TemplateIdID of a hosted template. Alternative to submitting content inline.
TemplateAliasAlias of a hosted template. Alternative to submitting content inline.
InlineCssInline <style> blocks of the template into the HTML. Defaults to true.
TagTag used to categorize messages. Max 1000 characters.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the broadcast message stream. Defaults to the outbound broadcast stream.
TrackOpensEnable open tracking.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files attached to every message.
Custom headers applied to every message.
Send bulk emails › Responses
The request was accepted for processing.
IdID of the bulk request.
StatusProcessing status of the request.
SubmittedAtTime Postmark received the request.
TotalMessagesTotal number of messages in the request.
PercentageCompleted0-100 value showing how much of the request Postmark has finished. 100 means processing finished, not that every message was delivered.
ReleasedCountMessages handed to the sending pipeline so far. Released is not the same as delivered.
FailedCountMessages that will not be delivered or retried (for example suppressed recipients or template render failures).
SubjectEmail subject. Omitted when the request had none.
Get bulk request status
Returns the status and progress of a bulk request. Bulk requests are scoped to the server that submitted them; using another server's token returns 404 (error code 12). Requires Bulk API approval.
path Parameters
bulkRequestIdID of the bulk request returned when it was submitted.
Get bulk request status › Responses
The status of the bulk request.
IdID of the bulk request.
StatusProcessing status of the request.
SubmittedAtTime Postmark received the request.
TotalMessagesTotal number of messages in the request.
PercentageCompleted0-100 value showing how much of the request Postmark has finished. 100 means processing finished, not that every message was delivered.
ReleasedCountMessages handed to the sending pipeline so far. Released is not the same as delivered.
FailedCountMessages that will not be delivered or retried (for example suppressed recipients or template render failures).
SubjectEmail subject. Omitted when the request had none.