openapi: 3.0.1
info:
title: Postmark Account Activate Messages API
description: 'Postmark makes sending and receiving email incredibly easy. The Account-level API allows users to
configure all Servers, Domains, and Sender Signatures associated
with an Account.
'
version: 0.9.0
servers:
- url: //api.postmarkapp.com/
tags:
- name: Messages
paths:
/messages/inbound/{messageid}/bypass:
put:
tags:
- Messages
summary: Postmark Bypass rules for a blocked inbound message
requestBody:
content: {}
parameters:
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/inbound/{messageid}/details:
get:
tags:
- Messages
summary: Postmark Inbound message details
parameters:
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/inbound/{messageid}/retry:
put:
tags:
- Messages
summary: Postmark Retry a failed inbound message for processing
requestBody:
content: {}
parameters:
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/inbound:
get:
tags:
- Messages
summary: Postmark Inbound message search
parameters:
- name: count
in: query
schema:
type: string
description: Number of bounces to return per request. Max 500.
example: <integer>
- name: offset
in: query
schema:
type: string
description: Number of bounces to skip.
example: <integer>
- name: recipient
in: query
schema:
type: string
description: Filter by the user who was receiving the email
example: <string>
- name: fromemail
in: query
schema:
type: string
description: Filter by the sender email address
example: <string>
- name: subject
in: query
schema:
type: string
description: Filter by email subject
example: <string>
- name: mailboxhash
in: query
schema:
type: string
description: Filter by mailboxhash
example: <string>
- name: tag
in: query
schema:
type: string
description: Filter by tag
example: <string>
- name: status
in: query
schema:
type: string
description: Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`)
example: <string>
- name: todate
in: query
schema:
type: string
description: Filter messages up to the date specified. e.g. `2014-02-01`
example: <string>
- name: fromdate
in: query
schema:
type: string
description: Filter messages starting from the date specified. e.g. `2014-02-01`
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound/clicks:
get:
tags:
- Messages
summary: Postmark Clicks for a all messages
parameters:
- name: count
in: query
schema:
type: string
description: Number of bounces to return per request. Max 500.
example: <integer>
- name: offset
in: query
schema:
type: string
description: Number of bounces to skip.
example: <integer>
- name: recipient
in: query
schema:
type: string
description: Filter by the user who was receiving the email
example: <string>
- name: tag
in: query
schema:
type: string
description: Filter by tag
example: <string>
- name: client_name
in: query
schema:
type: string
description: Filter by client name, i.e. Outlook, Gmail
example: <string>
- name: client_company
in: query
schema:
type: string
description: Filter by company, i.e. Microsoft, Apple, Google
example: <string>
- name: client_family
in: query
schema:
type: string
description: Filter by client family, i.e. OS X, Chrome
example: <string>
- name: os_name
in: query
schema:
type: string
description: Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7
example: <string>
- name: os_family
in: query
schema:
type: string
description: Filter by kind of OS used without specific version, i.e. OS X, Windows
example: <string>
- name: os_company
in: query
schema:
type: string
description: Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation
example: <string>
- name: platform
in: query
schema:
type: string
description: Filter by platform, i.e. webmail, desktop, mobile
example: <string>
- name: country
in: query
schema:
type: string
description: Filter by country messages were opened in, i.e. Denmark, Russia
example: <string>
- name: region
in: query
schema:
type: string
description: Filter by full name of region messages were opened in, i.e. Moscow, New York
example: <string>
- name: city
in: query
schema:
type: string
description: Filter by full name of region messages were opened in, i.e. Moscow, New York
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound/clicks/{messageid}:
get:
tags:
- Messages
summary: Postmark Retrieve Message Clicks
parameters:
- name: count
in: query
schema:
type: string
description: Number of bounces to return per request. Max 500.
example: <integer>
- name: offset
in: query
schema:
type: string
description: Number of bounces to skip.
example: <integer>
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound/opens:
get:
tags:
- Messages
summary: Postmark Opens for all messages
parameters:
- name: count
in: query
schema:
type: string
description: Number of bounces to return per request. Max 500.
example: <integer>
- name: offset
in: query
schema:
type: string
description: Number of bounces to skip.
example: <integer>
- name: recipient
in: query
schema:
type: string
description: Filter by the user who was receiving the email
example: <string>
- name: tag
in: query
schema:
type: string
description: Filter by tag
example: <string>
- name: client_name
in: query
schema:
type: string
description: Filter by client name, i.e. Outlook, Gmail
example: <string>
- name: client_company
in: query
schema:
type: string
description: Filter by company, i.e. Microsoft, Apple, Google
example: <string>
- name: client_family
in: query
schema:
type: string
description: Filter by client family, i.e. OS X, Chrome
example: <string>
- name: os_name
in: query
schema:
type: string
description: Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7
example: <string>
- name: os_family
in: query
schema:
type: string
description: Filter by kind of OS used without specific version, i.e. OS X, Windows
example: <string>
- name: os_company
in: query
schema:
type: string
description: Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation
example: <string>
- name: platform
in: query
schema:
type: string
description: Filter by platform, i.e. webmail, desktop, mobile
example: <string>
- name: country
in: query
schema:
type: string
description: Filter by country messages were opened in, i.e. Denmark, Russia
example: <string>
- name: region
in: query
schema:
type: string
description: Filter by full name of region messages were opened in, i.e. Moscow, New York
example: <string>
- name: city
in: query
schema:
type: string
description: Filter by full name of region messages were opened in, i.e. Moscow, New York
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound/opens/{messageid}:
get:
tags:
- Messages
summary: Postmark Retrieve Message Opens
parameters:
- name: count
in: query
schema:
type: string
description: Number of bounces to return per request. Max 500.
example: <integer>
- name: offset
in: query
schema:
type: string
description: Number of bounces to skip.
example: <integer>
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound/{messageid}/details:
get:
tags:
- Messages
summary: Postmark Outbound message details
parameters:
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound/{messageid}/dump:
get:
tags:
- Messages
summary: Postmark Outbound message dump
parameters:
- name: messageid
in: path
schema:
type: string
required: true
description: The ID of the message which should bypass inbound rules.
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}
/messages/outbound:
get:
tags:
- Messages
summary: Postmark Outbound message search
parameters:
- name: count
in: query
schema:
type: string
description: Number of bounces to return per request. Max 500.
example: <integer>
- name: offset
in: query
schema:
type: string
description: Number of bounces to skip.
example: <integer>
- name: recipient
in: query
schema:
type: string
description: Filter by the user who was receiving the email
example: <string>
- name: fromemail
in: query
schema:
type: string
description: Filter by the sender email address
example: <string>
- name: tag
in: query
schema:
type: string
description: Filter by tag
example: <string>
- name: status
in: query
schema:
type: string
description: Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`)
example: <string>
- name: todate
in: query
schema:
type: string
description: Filter messages up to the date specified. e.g. `2014-02-01`
example: <string>
- name: fromdate
in: query
schema:
type: string
description: Filter messages starting from the date specified. e.g. `2014-02-01`
example: <string>
responses:
'200':
description: Successful response
content:
application/json: {}