Postmark
Postmark API

View and edit the server that owns the server token used for the request.


Get the server

GET
https://api.postmarkapp.com
/server

Returns the settings of the server that owns the server token used for the request.

Get the server › Responses

The server.

A Postmark server.
ID
​integer

Unique ID of the server. Field of Server.

Example: 12345

Server name.

Example: Staging Testing
Color
​ServerColor · enum

Color used to identify the server in the Postmark UI.

Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange
Example: Blue

Whether sending through SMTP is enabled.

Example: true

Whether the raw email content is included in inbound webhooks.

Example: false

Webhook URL for inbound messages.

Example: https://hooks.example.com/inbound

Webhook URL for bounces (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/bounce

Webhook URL for opens (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/open

Webhook URL for deliveries (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/delivery

Webhook URL for clicks (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/click

Only post the open webhook for the first open of a message.

Example: false

Your own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.

Example:
InboundSpamThreshold
​CreateServerRequest/properties/InboundSpamThreshold · min: 0 · max: 30

Spam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).

Example: 5

Track opens by default for messages sent from this server.

Example: false
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText

Include the bounce content in bounce webhooks.

Example: true

Post SMTP API errors to the bounce webhook URL.

Example: false
ApiTokens
​string[]

Server API tokens (X-Postmark-Server-Token values).

Example: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
ServerLink
​string · uri

URL of the server in the Postmark UI.

Example: https://postmarkapp.com/servers/12345/streams
InboundAddress
​string

Inbound email address of the server.

Example: xxxxxxxxxxxxxxxx@inbound.postmarkapp.com
InboundHash
​string

Hash used in the server's inbound address.

Example: xxxxxxxxxxxxxxxx
DeliveryType
​string · enum

Whether the server delivers email (Live) or runs in sandbox mode (Sandbox).

Enum values:
Live
Sandbox
Example: Live

Edit the server

PUT
https://api.postmarkapp.com
/server

Updates settings of the server that owns the server token. Omitted fields are left unchanged.

Edit the server › Request Body

Settings to change. Omitted fields are left unchanged.

Server name.

Example: Staging Testing
Color
​ServerColor · enum

Color used to identify the server in the Postmark UI.

Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange
Example: Blue

Whether sending through SMTP is enabled.

Example: true

Whether the raw email content is included in inbound webhooks.

Example: false

Webhook URL for inbound messages.

Example: https://hooks.example.com/inbound

Webhook URL for bounces (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/bounce

Webhook URL for opens (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/open

Webhook URL for deliveries (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/delivery

Webhook URL for clicks (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/click

Only post the open webhook for the first open of a message.

Example: false

Your own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.

Example:
InboundSpamThreshold
​CreateServerRequest/properties/InboundSpamThreshold · min: 0 · max: 30

Spam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).

Example: 5

Track opens by default for messages sent from this server.

Example: false
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText

Include the bounce content in bounce webhooks.

Example: true

Post SMTP API errors to the bounce webhook URL.

Example: false

Edit the server › Responses

The updated server.

A Postmark server.
ID
​integer

Unique ID of the server. Field of Server.

Example: 12345

Server name.

Example: Staging Testing
Color
​ServerColor · enum

Color used to identify the server in the Postmark UI.

Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange
Example: Blue

Whether sending through SMTP is enabled.

Example: true

Whether the raw email content is included in inbound webhooks.

Example: false

Webhook URL for inbound messages.

Example: https://hooks.example.com/inbound

Webhook URL for bounces (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/bounce

Webhook URL for opens (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/open

Webhook URL for deliveries (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/delivery

Webhook URL for clicks (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/click

Only post the open webhook for the first open of a message.

Example: false

Your own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.

Example:
InboundSpamThreshold
​CreateServerRequest/properties/InboundSpamThreshold · min: 0 · max: 30

Spam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).

Example: 5

Track opens by default for messages sent from this server.

Example: false
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText

Include the bounce content in bounce webhooks.

Example: true

Post SMTP API errors to the bounce webhook URL.

Example: false
ApiTokens
​string[]

Server API tokens (X-Postmark-Server-Token values).

Example: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
ServerLink
​string · uri

URL of the server in the Postmark UI.

Example: https://postmarkapp.com/servers/12345/streams
InboundAddress
​string

Inbound email address of the server.

Example: xxxxxxxxxxxxxxxx@inbound.postmarkapp.com
InboundHash
​string

Hash used in the server's inbound address.

Example: xxxxxxxxxxxxxxxx
DeliveryType
​string · enum

Whether the server delivers email (Live) or runs in sandbox mode (Sandbox).

Enum values:
Live
Sandbox
Example: Live