Skip to main content

Postmark

Postmark is a transactional email delivery service focused on speed and deliverability for application email. The Postmark connector reads outbound and inbound messages, opens and clicks, bounces, delivery statistics, templates, message streams, suppressions, webhooks, inbound rules, bulk send status, servers, domains, and sender signatures, and can send single, batch, template-based, and bulk email, and create and manage templates, streams, suppressions, webhooks, servers, domains, and sender signatures.

Postmark icon

Power end-to-end data operations for your Postmark API with Nexla. Our bi-directional Postmark connector is purpose-built for Postmark, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Postmark or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Postmark workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Postmark API with a Postmark API token. Postmark has two kinds of token, and each endpoint works with only one of them:

  • Server API token: in Postmark, go to Servers, select your server, and open the API Tokens tab. A server token works with one server's data: sending email, bounces, templates, outbound and inbound messages, statistics, webhooks, inbound rules, suppressions, and message streams.

  • Account API token: in Postmark, go to Account, and open the API Tokens tab. An account token manages the account as a whole: servers, domains, sender signatures, pushing templates between servers, and data removal requests. Not every Postmark user role can see this tab; if you can't, ask your account owner.

A Nexla credential holds one token. Create one credential for each token type you need, and pick the matching credential when you set up a source or destination. Every endpoint template below is marked (server token) or (account token); with the wrong kind of credential, Postmark rejects the request with HTTP 401 Unauthorized. A server token reads and writes only its own server's data, so create a separate server-token credential for each Postmark server you work with.

For details, see Postmark's API authentication guide. Both tokens carry full access to what they cover, including sending email, so treat them like passwords. If a token is compromised, regenerate it on the same API Tokens tab.

Sends go to real recipients

Destinations that send email deliver it to the real addresses in your records as soon as the destination is activated, and Postmark counts every message against your plan. Eight destination templates send email and are marked Sends email below: Send Email, Send Batch Emails, Send Email With Template, Send Batch With Templates, Send Bulk Email, Push Templates To Server, Create Sender Signature, and Resend Sender Confirmation (the last two email a confirmation link to the sender address; Push Templates To Server sends nothing itself, but changes what live sends contain). Test sending templates with your own addresses first, or with a server whose delivery type is Sandbox, which accepts messages without delivering them.

Bulk API needs approval

The Send Bulk Email, List Bulk Email Requests, and Get Bulk Email Status templates use Postmark's Bulk API, which Postmark must approve for your account before use. Until then, Postmark rejects these requests. Contact Postmark support to request access.

Authenticate​

Credentials required​

Postmark server token, sent as the X-Postmark-Server-Token header (server API: email, bounces, templates, messages, stats, webhooks, inbound rules, suppressions, message streams).

FieldRequiredSecretDescription
Server API TokenYesYesYour Postmark server API token, from the API Tokens tab of the Postmark server. Sent as the X-Postmark-Server-Token header.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field. Include the token type, and for a server token the server it belongs to, so the right credential is easy to pick later.

  3. In the Authentication Type menu, select Server API Token or Account API Token, and paste the matching token from Prerequisites into the field. Nexla sends it in the X-Postmark-Server-Token or X-Postmark-Account-Token header on every request.

    Do not select No Authentication. That option is left over from an earlier version of the connector and cannot work: every Postmark API request needs a token, so every source and destination that uses such a credential fails.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests a server-token credential by reading the token's server, and an account-token credential by listing the account's servers.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Postmark connector tile, then select the credential that will be used to connect to Postmark, and click Next; or, create a new Postmark credential for use in this flow. Pick a server-token or account-token credential to match the template you plan to use.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Postmark endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say "Results are paged automatically" read every page; all other templates make a single request. List templates return one record per item, such as one record per bounce or message. Templates that need an ID, such as a message or template ID, read data for that one object; use the matching list template to find the ID. The templates send none of Postmark's optional filters, such as date ranges, tags, recipients, or message streams; to filter, use Manual configuration.

Servers​

Get Current Server (server token)

Retrieves the server that the server token belongs to, with its settings: tracking, inbound address and domain, and webhook URLs.

List Servers (account token)

Lists every server in the Postmark account with its settings and server API tokens.

  • Results are paged automatically, 100 records per page.
  • The response includes each server's API tokens, so restrict who can see this Nexset.
  • See the Postmark API reference for the response fields.

Get Server (account token)

Retrieves one server's settings, webhook URLs, and server API tokens.

  • Enter the Server ID. Use the List Servers template to find it.
  • The response includes the server's API tokens, so restrict who can see this Nexset.
  • See the Postmark API reference for the response fields.

Outbound messages​

List Outbound Messages (server token)

Lists sent messages with their recipients, subject, status, tag, and received time.

  • Results are paged automatically, 500 records per page. Postmark returns at most 10,000 records for a search, so very large result sets are cut off at 10,000.
  • Covers the default transactional stream (outbound) only; the template sends no stream, recipient, tag, or date filter.
  • See the Postmark API reference for the response fields.

Get Outbound Message Details (server token)

Retrieves one sent message with its HTML and text bodies, headers, recipients, and delivery events.

  • Enter the Message ID. Use the List Outbound Messages template to find it.
  • See the Postmark API reference for the response fields.

Get Outbound Message Dump (server token)

Retrieves the raw MIME source of one sent message as a single Body field.

  • Enter the Message ID. Use the List Outbound Messages template to find it.
  • See the Postmark API reference for the response fields.

List Message Opens (server token)

Lists open events for sent messages, with the recipient, email client, operating system, platform, location, and whether it was the first open.

  • Results are paged automatically, 500 records per page. Postmark returns at most 10,000 records for a search, so very large result sets are cut off at 10,000.
  • See the Postmark API reference for the response fields.

List Opens For Message (server token)

Lists the open events for one sent message.

  • Enter the Message ID. Use the List Outbound Messages template to find it.
  • Results are paged automatically, 500 records per page.
  • See the Postmark API reference for the response fields.

List Message Clicks (server token)

Lists link click events for sent messages, with the recipient, link, client, operating system, and location.

  • Results are paged automatically, 500 records per page. Postmark returns at most 10,000 records for a search, so very large result sets are cut off at 10,000.
  • See the Postmark API reference for the response fields.

List Clicks For Message (server token)

Lists the link click events for one sent message.

  • Enter the Message ID. Use the List Outbound Messages template to find it.
  • Results are paged automatically, 500 records per page.
  • See the Postmark API reference for the response fields.

Bulk email​

List Bulk Email Requests (server token)

Lists the bulk send requests on the server, newest first, with each request's status, totals, and percentage complete.

  • Requires the Postmark Bulk API, which Postmark must approve for your account first.
  • Results are paged automatically using Postmark's pagination key.
  • See the Postmark API reference for the response fields.

Get Bulk Email Status (server token)

Retrieves the status of one bulk send request: when it was submitted, and its total, released, and failed counts.

  • Enter the Bulk Request ID. Use the List Bulk Email Requests template, or the response of Send Bulk Email, to find it.
  • Requires the Postmark Bulk API, which Postmark must approve for your account first.
  • See the Postmark API reference for the response fields.

Bounces​

Get Delivery Stats (server token)

Retrieves the server's bounce summary: the number of inactive addresses and a count for each bounce type.

List Bounces (server token)

Lists bounces on the server with each bounce's type, recipient address, message ID, bounce time, and whether the address is now inactive.

  • Results are paged automatically, 500 records per page. Postmark returns at most 10,000 records for a search, so very large result sets are cut off at 10,000.
  • See the Postmark API reference for the response fields.

Get Bounce (server token)

Retrieves one bounce with its type, recipient, description, details, subject, and message stream.

  • Enter the Bounce ID. Use the List Bounces template to find it.
  • See the Postmark API reference for the response fields.

Get Bounce Dump (server token)

Retrieves the raw SMTP source of one bounce as a single Body field. The field is empty once the bounce is older than Postmark's retention period.

  • Enter the Bounce ID. Use the List Bounces template to find it.
  • See the Postmark API reference for the response fields.

Statistics​

Get Outbound Overview (server token)

Retrieves outbound totals for the server: sent, bounced, spam complaints, opens, clicks, and their rates.

  • Covers Postmark's whole retention window for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Sent Counts (server token)

Counts the emails sent each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Bounce Counts (server token)

Counts hard bounces, soft bounces, transient errors, and SMTP API errors each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Spam Complaints (server token)

Counts spam complaints each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Tracked Email Counts (server token)

Counts the emails sent with open tracking each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Open Counts (server token)

Counts total and unique opens each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Open Platforms (server token)

Counts opens by platform (desktop, mobile, webmail) each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Open Email Clients (server token)

Counts opens by email client each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Click Counts (server token)

Counts total and unique link clicks each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Click Browsers (server token)

Counts clicks by browser family each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Click Platforms (server token)

Counts clicks by platform (desktop, mobile) each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Get Click Locations (server token)

Counts clicks by where the link was in the email (HTML or text part) each day.

  • Returns one record per day across Postmark's whole retention window, for the default transactional stream (outbound). The template sends no date range, tag, or stream filter.
  • See the Postmark API reference for the response fields.

Templates​

List Templates (server token)

Lists the templates and layouts on the server with each one's ID, name, alias, type, and whether it is active.

Get Template (server token)

Retrieves one template with its subject, HTML and text bodies, layout, and type.

  • Enter the Template ID or Alias. Enter the template's numeric ID or its alias; use the List Templates template to find it.
  • See the Postmark API reference for the response fields.

Inbound messages​

List Inbound Messages (server token)

Lists processed inbound messages with the sender, recipients, subject, mailbox hash, status, and date.

  • Results are paged automatically, 500 records per page. Postmark returns at most 10,000 records for a search, so very large result sets are cut off at 10,000.
  • See the Postmark API reference for the response fields.

Get Inbound Message Details (server token)

Retrieves one inbound message with its sender, recipients, bodies, headers, attachments, and the reason it was blocked, if it was.

  • Enter the Message ID. Use the List Inbound Messages template to find it.
  • See the Postmark API reference for the response fields.

List Inbound Rules (server token)

Lists the inbound rules (blocked sender addresses and domains) on the server.

Message streams and suppressions​

List Message Streams (server token)

Lists the server's message streams (transactional, broadcast, and inbound). Archived streams are not included.

Get Message Stream (server token)

Retrieves one message stream's settings.

  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • See the Postmark API reference for the response fields.

List Suppressions (server token)

Lists the suppressed recipients on a message stream with each address's suppression reason, origin, and date.

  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • See the Postmark API reference for the response fields.

Webhooks​

List Webhooks (server token)

Lists the server's webhooks across all streams with each webhook's URL, stream, and enabled triggers.

Get Webhook (server token)

Retrieves one webhook's URL, stream, HTTP authentication, custom headers, and triggers.

  • Enter the Webhook ID. Use the List Webhooks template to find it.
  • See the Postmark API reference for the response fields.

Get Webhook Statistics (server token)

Retrieves delivery statistics for one webhook over the last 24 hours.

  • Enter the Webhook ID. Use the List Webhooks template to find it.
  • See the Postmark API reference for the response fields.

Domains and sender signatures​

List Domains (account token)

Lists the account's sending domains with their SPF, DKIM, and Return-Path verification status.

Get Domain (account token)

Retrieves one domain with the DNS records to add and its SPF, DKIM, and Return-Path verification state.

  • Enter the Domain ID. Use the List Domains template to find it.
  • See the Postmark API reference for the response fields.

List Sender Signatures (account token)

Lists the account's sender signatures (confirmed from addresses) and whether each is confirmed.

Get Sender Signature (account token)

Retrieves one sender signature with its from address, reply-to address, confirmation state, and DNS state.

  • Enter the Sender Signature ID. Use the List Sender Signatures template to find it.
  • See the Postmark API reference for the response fields.

Data removal​

Get Data Removal Status (account token)

Retrieves the status of a data removal request.

  • Enter the Data Removal ID. Use the ID returned by the Create Data Removal destination.
  • See the Postmark API reference for the response fields.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Postmark data sources can also be manually configured to ingest data from any valid Postmark API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or optional filters that the templates do not send, such as a date range, tag, recipient, or messagestream filter. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Postmark endpoint URLs take the form https://api.postmarkapp.com/...; Postmark's search endpoints require the count and offset query parameters. See the Postmark API reference for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Postmark data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Postmark destination, and select the Send to Destination option from the menu. Select the Postmark connector from the list of available destination connectors, then select the credential that will be used to connect to Postmark, and click Next; or, create a new Postmark credential for use in this flow. Pick a server-token or account-token credential to match the template you plan to use.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Postmark endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Unless a template says otherwise, each record in the Nexset is sent as the JSON body of one request, one record at a time, so shape each record to match the request body that Postmark documents for the endpoint. Postmark field names are case-sensitive and start with a capital letter, such as From and HtmlBody. ID settings, such as a template or domain ID, are fixed on the destination and apply to every record it sends. Templates are marked Sends email when they cause Postmark to send email, and Side effect when they delete data or make other changes that cannot be undone from Nexla.

Sending email​

Send Email (server token)

Sends one email for each record. Each record is the request body: From, To, Subject, HtmlBody or TextBody, and optionally MessageStream, Tag, and tracking settings. The From address must be a confirmed sender signature or on a verified domain.

  • Sends email: sends one email to the record's recipients.
  • See the Postmark API reference for the request body fields.

Send Batch Emails (server token)

Sends up to 500 emails in one request. Each record is one message, shaped like a Send Email record; Nexla groups records into batches of up to 500.

Send Email With Template (server token)

Sends one email for each record, built from a Postmark template. Each record includes TemplateId or TemplateAlias, TemplateModel (the template variables), From, and To.

  • Sends email: sends one email to the record's recipients.
  • The template must already exist on the server.
  • See the Postmark API reference for the request body fields.

Send Batch With Templates (server token)

Sends up to 500 template-based emails in one request. Each record is one message, shaped like a Send Email With Template record; Nexla groups records into batches of up to 500.

Send Bulk Email (server token)

Submits one bulk send request per record. Each record is the request body: From, Subject, HtmlBody or TextBody, and a Messages array with each recipient and its variables. Check progress with the Get Bulk Email Status source template.

  • Sends email: sends an email to every recipient in the record's Messages array.
  • Requires the Postmark Bulk API, which Postmark must approve for your account first.
  • See the Postmark API reference for the request body fields.

Templates​

Create Template (server token)

Creates a template or layout from each record. A record carries Name, Subject, HtmlBody or TextBody, and optionally Alias, TemplateType, and LayoutTemplate.

Update Template (server token)

Updates a template. Each record contains only the fields to change.

  • Enter the Template ID or Alias. Enter the template's numeric ID or its alias; use the List Templates template to find it.
  • See the Postmark API reference for the request body fields.

Delete Template (server token)

Deletes a template.

  • Side effect: permanently deletes the template; email sends that reference it fail.
  • Enter the Template ID or Alias. Enter the template's numeric ID or its alias; use the List Templates template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Validate Template (server token)

Checks template content and renders it with test data, without saving anything. A record carries Subject, HtmlBody, TextBody, and optionally TestRenderModel.

Push Templates To Server (account token)

Copies changed templates from one server to another. A record carries SourceServerID, DestinationServerID, and PerformChanges (set it to false to preview the changes without applying them).

  • Sends email: the push itself sends no message, but pushed templates go live on the destination server at once, so the next emails that server sends with them use the new content.
  • Side effect: overwrites templates on the destination server.
  • See the Postmark API reference for the request body fields.

Bounces and inbound messages​

Activate Bounce (server token)

Reactivates an address that Postmark deactivated after a bounce, so Postmark sends to it again.

  • Side effect: re-enables sending to the address.
  • Enter the Bounce ID. Use the List Bounces template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Bypass Inbound Rules (server token)

Processes an inbound message that an inbound rule blocked.

  • Side effect: Postmark delivers the blocked message to your inbound webhook.
  • Enter the Message ID. Use the List Inbound Messages template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Retry Inbound Message (server token)

Retries an inbound message that failed to process.

  • Side effect: Postmark posts the message to your inbound webhook again.
  • Enter the Message ID. Use the List Inbound Messages template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Create Inbound Rule (server token)

Blocks inbound email from a sender address or domain. Each record carries Rule, the address or domain to block.

Delete Inbound Rule (server token)

Deletes an inbound rule.

  • Side effect: unblocks the sender address or domain.
  • Enter the Inbound Rule ID. Use the List Inbound Rules template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Message streams and suppressions​

Create Message Stream (server token)

Creates a message stream from each record. A record carries ID, Name, MessageStreamType (Transactional or Broadcasts), and optionally Description.

Edit Message Stream (server token)

Updates a stream's name, description, or unsubscribe settings. Each record contains only the fields to change.

  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • See the Postmark API reference for the request body fields.

Archive Message Stream (server token)

Archives a message stream. Postmark purges an archived stream's data after 45 days unless it is unarchived first.

  • Side effect: archives the stream; its data is deleted after 45 days.
  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Unarchive Message Stream (server token)

Restores an archived message stream before its purge date.

  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Create Suppressions (server token)

Suppresses recipient addresses on a message stream, so Postmark stops sending to them. Each record carries an EmailAddress field; Nexla groups records into batches of 50.

  • Side effect: stops sending to the addresses on that stream.
  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • See the Postmark API reference for the request body fields.

Delete Suppressions (server token)

Removes suppressions from a message stream, so Postmark sends to the addresses again. Each record carries an EmailAddress field; Nexla groups records into batches of 50.

  • Side effect: re-enables sending to the addresses on that stream.
  • Enter the Message Stream ID. This is the stream's ID, such as outbound or broadcast; use the List Message Streams template to find it.
  • See the Postmark API reference for the request body fields.

Webhooks​

Create Webhook (server token)

Creates a webhook from each record. A record carries Url, MessageStream, Triggers, and optionally HttpAuth and HttpHeaders.

Edit Webhook (server token)

Updates a webhook's URL, authentication, headers, or triggers. Each record contains only the fields to change.

  • Enter the Webhook ID. Use the List Webhooks template to find it.
  • See the Postmark API reference for the request body fields.

Delete Webhook (server token)

Deletes a webhook.

  • Side effect: permanently deletes the webhook; Postmark stops posting those events.
  • Enter the Webhook ID. Use the List Webhooks template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Verify Webhook (server token)

Sends a test event for each enabled trigger to the webhook URL, and marks the webhook verified or not.

  • Side effect: Postmark posts test events to your webhook URL.
  • Enter the Webhook ID. Use the List Webhooks template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Servers​

Edit Current Server (server token)

Updates the settings of the server the server token belongs to, such as its name, color, open and link tracking, and webhook URLs. Each record contains only the fields to change.

Create Server (account token)

Creates a server from each record. A record carries Name and optionally Color, DeliveryType (Live or Sandbox), and tracking and webhook settings.

Edit Server (account token)

Updates a server's settings. Each record contains only the fields to change.

  • Enter the Server ID. Use the List Servers template to find it.
  • See the Postmark API reference for the request body fields.

Delete Server (account token)

Deletes a server.

  • Side effect: permanently deletes the server and all of its data.
  • Enter the Server ID. Use the List Servers template to find it.
  • Postmark support must enable server deletion through the API for your account first.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Domains​

Create Domain (account token)

Adds a sending domain from each record. A record carries Name and optionally ReturnPathDomain. Use the Get Domain source template to see the DNS records to add.

Edit Domain (account token)

Changes a domain's ReturnPathDomain.

  • Enter the Domain ID. Use the List Domains template to find it.
  • See the Postmark API reference for the request body fields.

Delete Domain (account token)

Deletes a sending domain.

  • Side effect: removes the domain; you can no longer send from it unless its addresses have sender signatures.
  • Enter the Domain ID. Use the List Domains template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Rotate Domain DKIM (account token)

Starts a DKIM key rotation for a domain. Publish the new DKIM DNS record shown by Get Domain to finish the rotation.

  • Side effect: replaces the domain's DKIM key.
  • Enter the Domain ID. Use the List Domains template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Verify Domain DKIM (account token)

Checks the domain's DKIM DNS record again, and returns the domain.

  • Enter the Domain ID. Use the List Domains template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Verify Domain Return-Path (account token)

Checks the domain's Return-Path CNAME record again, and returns the domain.

  • Enter the Domain ID. Use the List Domains template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Verify Domain SPF (account token)

Checks the domain's SPF record again. Postmark has deprecated this check.

  • Enter the Domain ID. Use the List Domains template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Sender signatures​

Create Sender Signature (account token)

Adds a sender signature (a from address) from each record. A record carries FromEmail, Name, and optionally ReplyToEmail and ReturnPathDomain.

  • Sends email: Postmark emails a confirmation link to the FromEmail address.
  • See the Postmark API reference for the request body fields.

Edit Sender Signature (account token)

Updates a sender signature's Name, ReplyToEmail, or ReturnPathDomain.

  • Enter the Sender Signature ID. Use the List Sender Signatures template to find it.
  • See the Postmark API reference for the request body fields.

Delete Sender Signature (account token)

Deletes a sender signature.

  • Side effect: removes the from address; email sent from it fails unless its domain is verified.
  • Enter the Sender Signature ID. Use the List Sender Signatures template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Resend Sender Confirmation (account token)

Resends the confirmation email for a sender signature that is not yet confirmed.

  • Sends email: Postmark emails a confirmation link to the signature's address.
  • Enter the Sender Signature ID. Use the List Sender Signatures template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Request New Sender DKIM (account token)

Requests a new DKIM key for the signature's domain. Postmark has deprecated this call in favor of Rotate Domain DKIM.

  • Side effect: replaces the DKIM key.
  • Enter the Sender Signature ID. Use the List Sender Signatures template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Verify Sender SPF (account token)

Checks the signature's SPF record again. Postmark has deprecated this check.

  • Enter the Sender Signature ID. Use the List Sender Signatures template to find it.
  • The record's content is not sent; each record repeats the same request, so send a single record.
  • See the Postmark API reference for the request body fields.

Data removal​

Create Data Removal (account token)

Asks Postmark to erase all data it holds for a recipient. A record carries RequestedBy, RequestedFor (the recipient's address), and NotifyWhenCompleted. Check progress with the Get Data Removal Status source template.

  • Side effect: permanently deletes the recipient's data from Postmark; it cannot be recovered.
  • See the Postmark API reference for the request body fields.

Manual configuration​

Postmark destinations can also be manually configured to send data to any valid Postmark API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Postmark API expects JSON request bodies. Nexla adds the token header from the credential, so leave X-Postmark-Server-Token and X-Postmark-Account-Token out of the request headers.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Postmark endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Postmark endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.