{"openapi":"3.0.0","info":{"description":"Email delivery service"},"servers":[{"description":"Email delivery service","url":"https://api.apirails.com/postmark"}],"paths":{"/email":{"post":{"tags":["Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/email-api#send-a-single-email","api_endpoint":"https://api.postmarkapp.com/email"},"summary":"Send a single email","description":"Send a single email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Attachments":{"type":"array","description":"List of attachments","items":{"type":"string"}},"Bcc":{"type":"string","description":"Bcc recipient email address. Multiple addresses are comma separated. Max 50.\nSubject","enum":["string"]},"Cc":{"type":"string","description":"Cc recipient email address. Multiple addresses are comma separated. Max 50."},"From":{"type":"string","description":"The sender email address. Must have a registered and confirmed Sender Signature.To include a name use the format \"Full Name <sender@domain.com>\" for the address.","required":true},"Headers":{"type":"array","description":"List of custom headers to include.","items":{"type":"string"}},"HtmlBody":{"type":"string","description":"If no TextBody specified HTML email message","required":true},"MessageStream":{"type":"string","description":"Set message stream ID that's used for sending.If not provided message will default to the \"outbound\" transactional stream."},"Metadata":{"type":"object","description":"Custom metadata key/value pairs.","properties":{}},"ReplyTo":{"type":"string","description":"Reply To override email address.Defaults to the Reply To set in the sender signature. Multiple addresses are comma separated."},"Tag":{"type":"string","description":"Email tag that allows you to categorize outgoing emails and get detailed statistics."},"TextBody":{"type":"string","description":"If no HtmlBody specified Plain text email message","required":true},"To":{"type":"string","description":"Recipient email address.Multiple addresses are comma separated.Max 50.","required":true},"TrackLinks":{"type":"string","description":"Activate link tracking for links in the HTML or Text bodies of this email.Possible options; None HtmlAndText HtmlOnly TextOnly"},"TrackOpens":{"type":"boolean","description":"Activate open tracking for this email.","enum":[true,false]}}},"example":{"Attachments":[],"Bcc":"","Cc":"","From":"","Headers":[],"HtmlBody":"","MessageStream":"","Metadata":{},"ReplyTo":"","Tag":"","TextBody":"","To":"","TrackLinks":"","TrackOpens":""}}}}}},"/email/batch":{"post":{"tags":["Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/email-api#send-batch-emails","api_endpoint":"https://api.postmarkapp.com/email/batch"},"summary":"Send batch emails","description":"Send batch emails","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Attachments":{"type":"array","description":"List of attachments","items":{"type":"string"}},"Bcc":{"type":"string","description":"Bcc recipient email address. Multiple addresses are comma separated. Max 50."},"Cc":{"type":"string","description":"Cc recipient email address. Multiple addresses are comma separated. Max 50."},"From":{"type":"string","description":"The sender email address. Must have a registered and confirmed Sender Signature. To include a name, use the format \"Full Name <sender@domain.com>\". Punctuation in the name would need to be escaped.","required":true},"Headers":{"type":"array","description":"List of custom headers to include.","items":{"type":"string"}},"HtmlBody":{"type":"string","description":"If no TextBody specified HTML email message"},"MessageStream":{"type":"string","description":"Set message stream ID that's used for sending.If not provided message will default to the \"outbound\" transactional stream."},"Metadata":{"type":"object","description":"Custom metadata key/value pairs.","properties":{}},"ReplyTo":{"type":"string","description":"Reply To override email address. Defaults to the Reply To set in the sender signature."},"Subject":{"type":"string","description":"Email subject"},"Tag":{"type":"string","description":"Email tag that allows you to categorize outgoing emails and get detailed statistics."},"TextBody":{"type":"string","description":"If no HtmlBody specified Plain text email message"},"To":{"type":"string","description":"Recipient email address. Multiple addresses are comma separated. Max 50.","required":true},"TrackLinks":{"type":"string","description":"Activate link tracking for links in the HTML or Text bodies of this email. Possible options: None HtmlAndText HtmlOnly TextOnly"},"TrackOpens":{"type":"boolean","description":"Activate open tracking for this email.","enum":[true,false]}}},"example":{"Attachments":[],"Bcc":"","Cc":"","From":"","Headers":[],"HtmlBody":"","MessageStream":"","Metadata":{},"ReplyTo":"","Subject":"","Tag":"","TextBody":"","To":"","TrackLinks":"","TrackOpens":""}}}}}},"/message-streams/{stream_ID}/unarchive":{"post":{"tags":["Message Stream"],"parameters":[{"name":"stream_ID","in":"path","description":"Stream ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/message-streams-api#unarchive-a-stream","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_ID}/unarchive"},"summary":"Unarchive a message stream","description":"Unarchive a message stream ","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messages/outbound":{"get":{"tags":["Messages"],"parameters":[{"name":"count","in":"query","description":"Number of messages to return per request. Max 500.Count + Offset cannot exceed 10000 messages","required":true,"schema":{"type":"string","example":""}},{"name":"fromdate","in":"query","description":"Filter messages starting from the date/time specified (inclusive)e.g. 2021-01-01T12","schema":{"type":"string","example":"","items":{"type":"string","enum":["00"]}}},{"name":"fromemail","in":"query","description":"Filter by the sender email address","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream ID.If not provided message will default to the 'outbound' transactional stream","schema":{"type":"string","example":""}},{"name":"metadata_","in":"query","description":"Filter by metadata value e.g. metadata_color.","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of messages to skip.Count + Offset cannot exceed 10000 messages","required":true,"schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"Filter by the user who was receiving the email","schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Filter by status (queued or sent / processed).Note that sent and processed will return the same results and can be used interchangeably","schema":{"type":"string","example":""}},{"name":"subject","in":"query","description":"Filter by email subject","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter messages up to the date/time specified (inclusive). e.g. 2021-01-01T12","schema":{"type":"string","example":"","items":{"type":"string","enum":["00"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#outbound-message-search","api_endpoint":"https://api.postmarkapp.com/messages/outbound"},"summary":"Outbound message search","description":"Outbound message search ","security":[{"bearerAuth":[]}]}},"/deliverystats":{"get":{"tags":["Bounce"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/bounce-api#delivery-stats","api_endpoint":"https://api.postmarkapp.com/deliverystats"},"summary":"Get delivery stats","description":"Get delivery stats","security":[{"bearerAuth":[]}]}},"/bounces":{"get":{"tags":["Bounce"],"parameters":[{"name":"type","in":"query","description":"Filter by type of bounce","schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"Number of bounces to return per request.Max 500.Count + Offset cannot exceed 10000 bounces.","required":true,"schema":{"type":"string","example":""}},{"name":"emailFilter","in":"query","description":"Filter by email address","schema":{"type":"string","example":""}},{"name":"fromdate","in":"query","description":"Filter messages starting from the date/time specified (inclusive) e.g. 2021-01-01T12","schema":{"type":"string","example":"","items":{"type":"string","enum":["00"]}}},{"name":"inactive","in":"query","description":"Filter by emails that were deactivated by Postmark due to the bounce.Set to true or false. If this isn’t specified it will return both active and inactive.","schema":{"type":"string","example":""}},{"name":"messageID","in":"query","description":"Filter by messageID","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream ID. If not provided message will default to the outbound transactional stream.","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of bounces to skip. Count + Offset cannot exceed 10,000 bounces.","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter messages up to the date/time specified (inclusive) e.g. 2021-01-01T12","schema":{"type":"string","example":"","items":{"type":"string","enum":["00"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/bounce-api#bounces","api_endpoint":"https://api.postmarkapp.com/bounces"},"summary":"Get bounces","description":"Get bounces","security":[{"bearerAuth":[]}]}},"/bounces/{bounceid}":{"get":{"tags":["Bounce"],"parameters":[{"name":"bounceid","in":"path","description":"Bounce ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/bounce-api#single-bounce","api_endpoint":"https://api.postmarkapp.com/bounces/{bounceid}"},"summary":"Get a single bounce","description":"Get a single bounce","security":[{"bearerAuth":[]}]}},"/bounces/{bounceid}/dump":{"get":{"tags":["Bounce"],"parameters":[{"name":"bounceid","in":"path","description":"Bounce ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/bounce-api#bounce-dump","api_endpoint":"https://api.postmarkapp.com/bounces/{bounceid}/dump"},"summary":"Get bounce dump","description":"Get bounce dump","security":[{"bearerAuth":[]}]}},"/bounces/{bounceid}/activate":{"put":{"tags":["Bounce"],"parameters":[{"name":"bounceid","in":"path","description":"Bounce ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/bounce-api#activate-bounce","api_endpoint":"https://api.postmarkapp.com/bounces/{bounceid}/activate"},"summary":"Activate a bounce","description":"Activate a bounce","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/domains":{"get":{"tags":["Domains"],"parameters":[{"name":"count","in":"query","description":"Number of records to return per request.Max 500","required":true,"schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of records to skip.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#list-domains","api_endpoint":"https://api.postmarkapp.com/domains"},"summary":"List domains","description":"List domains","security":[{"bearerAuth":[]}]},"post":{"tags":["Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#create-domain","api_endpoint":"https://api.postmarkapp.com/domains"},"summary":"Create a domain","description":"Create a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"Domain name","required":true},"ReturnPathDomain":{"type":"string","description":"A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net. For more information about this field please read our support page."}}},"example":{"Name":"example.com","ReturnPathDomain":"pm-bounces.example.com"}}}}}},"/domains/{domainid}":{"get":{"tags":["Domains"],"parameters":[{"name":"domainid","in":"path","description":"Domain ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#domain","api_endpoint":"https://api.postmarkapp.com/domains/{domainid}"},"summary":"Get a domain’s details","description":"Get a domain’s details","security":[{"bearerAuth":[]}]},"put":{"tags":["Domains"],"parameters":[{"name":"domainid","in":"path","description":"Domain ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#edit-domain","api_endpoint":"https://api.postmarkapp.com/domains/{domainid}"},"summary":"Edit a domain","description":"Edit a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ReturnPathDomain":{"type":"string","description":"A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net."}}},"example":{"ReturnPathDomain":"pm-bounces.example.com"}}}}},"delete":{"tags":["Domains"],"parameters":[{"name":"domainid","in":"path","description":"Domain ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#delete-domain","api_endpoint":"https://api.postmarkapp.com/domains/{domainid}"},"summary":"Verify DKIM Status","description":"Verify DKIM Status","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/domains/{domainid}/verifyReturnPath":{"put":{"tags":["Domains"],"parameters":[{"name":"domainid","in":"path","description":"Domain ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#domains-verify-return-path","api_endpoint":"https://api.postmarkapp.com/domains/{domainid}/verifyReturnPath"},"summary":"Verify Return-Path Status","description":"Verify Return-Path Status","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/domains/{domainid}/rotatedkim":{"post":{"tags":["Domains"],"parameters":[{"name":"domainid","in":"path","description":"Domain ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/domains-api#rotate-dkim","api_endpoint":"https://api.postmarkapp.com/domains/{domainid}/rotatedkim"},"summary":"Rotate DKIM keys","description":"Rotate DKIM keys","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/triggers/inboundrules":{"get":{"tags":["Inbound Rules Triggers"],"parameters":[{"name":"count","in":"query","description":"Number of records to return per request","required":true,"schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of records to skip.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/inbound-rules-triggers-api","api_endpoint":"https://api.postmarkapp.com/triggers/inboundrules"},"summary":"List inbound rule triggers","description":"List inbound rule triggers","security":[{"bearerAuth":[]}]},"post":{"tags":["Inbound Rules Triggers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/inbound-rules-triggers-api#create-trigger","api_endpoint":"https://api.postmarkapp.com/triggers/inboundrules"},"summary":"Create an inbound rule trigger","description":"Create an inbound rule trigger","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Rule":{"type":"string","description":"Email address (or domain) that you would like to block from sending.","required":true}}},"example":{"Rule":""}}}}}},"/triggers/inboundrules/{triggerid}":{"delete":{"tags":["Inbound Rules Triggers"],"parameters":[{"name":"triggerid","in":"path","description":"Trigger ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/inbound-rules-triggers-api#delete-single-trigger","api_endpoint":"https://api.postmarkapp.com/triggers/inboundrules/{triggerid}"},"summary":"Delete a single trigger","description":"Delete a single trigger","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/message-streams":{"get":{"tags":["Message Stream"],"parameters":[{"name":"IncludeArchivedStreams","in":"query","description":"Boolean filter for including archived message streams in list.Defaults to False.","schema":{"type":"string","example":""}},{"name":"MessageStreamType","in":"query","description":"Filters message streams based on stream type.Possible options; All Inbound Transactional Broadcasts.Defaults to All","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/message-streams-api#list-message-streams","api_endpoint":"https://api.postmarkapp.com/message-streams"},"summary":"List message streams","description":"List message streams","security":[{"bearerAuth":[]}]},"post":{"tags":["Message Stream"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/message-streams-api#create-a-message-stream","api_endpoint":"https://api.postmarkapp.com/message-streams"},"summary":"Create a message stream","description":"Create a message stream","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"A description of the message stream"},"ID":{"type":"string","description":"The ID of the message stream being created.This is used when sending messages to specify the sending message stream","required":true},"MessageStreamType":{"type":"string","description":"The type of message stream being created. Possible options Broadcasts Transasctional","required":true},"Name":{"type":"string","description":"The name of the message stream","required":true},"SubscriptionManagementConfiguration":{"type":"object","description":"Subscription management options for the Stream","properties":{}},"UnsubscribeHandlingType":{"type":"string","description":"The unsubscribe management option for the stream.For transactional streams default is None.For broadcast streams default is Postmark.Unsubscribe management is required for broadcast message streams approved accounts can use Custom.Possible options; none Postmark Custom."}}},"example":{"Description":"This is my second transactional stream","ID":"transactional-dev","MessageStreamType":"Transactional","Name":"My Dev Transactional Stream","SubscriptionManagementConfiguration":{"UnsubscribeHandlingType":"None"},"UnsubscribeHandlingType":""}}}}}},"/message-streams/{stream_ID}":{"get":{"tags":["Message Stream"],"parameters":[{"name":"stream_ID","in":"path","description":"Stream ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/message-streams-api#get-a-message-stream","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_ID}"},"summary":"Get a message stream","description":"Get a message stream","security":[{"bearerAuth":[]}]},"patch":{"tags":["Message Stream"],"parameters":[{"name":"stream_ID","in":"path","description":"Stream ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/message-streams-api#edit-a-message-stream","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_ID}"},"summary":"Edit a message stream","description":"Edit a message stream","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"Description of message stream"},"Name":{"type":"string","description":"Name of message stream"},"SubscriptionManagementConfiguration":{"type":"object","description":"Subscription management options for the Stream","properties":{}},"UnsubscribeHandlingType":{"type":"string","description":"The unsubscribe management option for the stream.For transactional streams default is None For broadcast streams default is Postmark. Unsubscribe management is required for broadcast message streams approved accounts can use Custom.Possible options","enum":["none Postmark Custom."]}}},"example":{"Description":"Updating my dev transactional stream","Name":"Updated Dev Stream","SubscriptionManagementConfiguration":{},"UnsubscribeHandlingType":""}}}}}},"/message-streams/{stream_ID}/archive":{"post":{"tags":["Message Stream"],"parameters":[{"name":"stream_ID","in":"path","description":"Stream ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/message-streams-api#archive-a-message-stream","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_ID}/archive"},"summary":"Archive a message stream","description":"Archive a message stream","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messages/outbound/{messageid}/details":{"get":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#outbound-message-details","api_endpoint":"https://api.postmarkapp.com/messages/outbound/{messageid}/details"},"summary":"Outbound message details","description":"Outbound message details","security":[{"bearerAuth":[]}]}},"/messages/outbound/{messageid}/dump":{"get":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#outbound-message-dump","api_endpoint":"https://api.postmarkapp.com/messages/outbound/{messageid}/dump"},"summary":"Outbound message dump","description":"Outbound message dump","security":[{"bearerAuth":[]}]}},"/messages/inbound":{"get":{"tags":["Messages"],"parameters":[{"name":"count","in":"query","description":"Number of messages to return per request.Max 500.Count + Offset cannot exceed 10000 messages","required":true,"schema":{"type":"string","example":""}},{"name":"fromdate","in":"query","description":"Filter messages starting from the date specified (inclusive).e.g. 2021-01-01T12","schema":{"type":"string","example":"","items":{"type":"string","enum":["00"]}}},{"name":"fromemail","in":"query","description":"Filter by the sender email address","schema":{"type":"string","example":""}},{"name":"mailboxhash","in":"query","description":"Filter by mailboxhash","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of messages to skip.Count + Offset cannot exceed 10000 messages","required":true,"schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"Filter by the user who was receiving the email","schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Filter by status (blocked processed  queued failed scheduled)","schema":{"type":"string","example":""}},{"name":"subject","in":"query","description":"Filter by email subject","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter messages up to the date specified (inclusive).e.g. 2021-01-01T12","schema":{"type":"string","example":"","items":{"type":"string","enum":["00"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#inbound-message-search","api_endpoint":"https://api.postmarkapp.com/messages/inbound"},"summary":"Inbound message search","description":"Inbound message search","security":[{"bearerAuth":[]}]}},"/messages/inbound/{messageid}/details":{"get":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#inbound-message-details","api_endpoint":"https://api.postmarkapp.com/messages/inbound/{messageid}/details"},"summary":"Inbound message details","description":"Inbound message details","security":[{"bearerAuth":[]}]}},"/messages/inbound/{messageid}/bypass":{"put":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#inbound-message-bypass","api_endpoint":"https://api.postmarkapp.com/messages/inbound/{messageid}/bypass"},"summary":"Bypass rules for a blocked inbound message","description":"Bypass rules for a blocked inbound message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messages/inbound/{messageid}/retry":{"put":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#inbound-message-retry","api_endpoint":"https://api.postmarkapp.com/messages/inbound/{messageid}/retry"},"summary":"Retry a failed inbound message for processing","description":"Retry a failed inbound message for processing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/messages/outbound/opens":{"get":{"tags":["Messages"],"parameters":[{"name":"city","in":"query","description":"Filter by full name of city messages were opened in i.e.Minneapolis Philadelphia","schema":{"type":"string","example":""}},{"name":"client_company","in":"query","description":"Filter by company i.e.Microsoft Apple Google","schema":{"type":"string","example":""}},{"name":"client_family","in":"query","description":"Filter by client family i.e.OS X Chrome","schema":{"type":"string","example":""}},{"name":"client_name","in":"query","description":"Filter by client name i.e.Outlook Gmail","schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"Number of messages to return per request.Max 500.Count + Offset cannot exceed 10000 messages","required":true,"schema":{"type":"string","example":""}},{"name":"country","in":"query","description":"Filter by country messages were opened in i.e.Denmark Russia","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream ID.If not provided search will default to the outbound transactional stream","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of messages to skip.Count + Offset cannot exceed 10000 messages","required":true,"schema":{"type":"string","example":""}},{"name":"os_company","in":"query","description":"Filter by company which produced the OS i.e. Apple Computer Inc.Microsoft Corporation","schema":{"type":"string","example":""}},{"name":"os_family","in":"query","description":"Filter by kind of OS used without specific version i.e. OS X Windows","schema":{"type":"string","example":""}},{"name":"os_name","in":"query","description":"Filter by full OS name and specific version i.e. OS X 10.9 Mavericks Windows 7","schema":{"type":"string","example":""}},{"name":"platform","in":"query","description":"Filter by platform i.e. webmail desktop mobile","schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"Filter by To Cc Bcc","schema":{"type":"string","example":""}},{"name":"region","in":"query","description":"Filter by full name of region messages were opened in i.e.Moscow New York","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#message-opens","api_endpoint":"https://api.postmarkapp.com/messages/outbound/opens"},"summary":"Message opens","description":"Message opens","security":[{"bearerAuth":[]}]}},"/messages/outbound/opens/{messageid}":{"get":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"Number of message opens to return per request. Max 500","required":true,"schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of messages to skip","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#opens-for-message","api_endpoint":"https://api.postmarkapp.com/messages/outbound/opens/{messageid}"},"summary":"Opens for a single message","description":"Opens for a single message","security":[{"bearerAuth":[]}]}},"/messages/outbound/clicks":{"get":{"tags":["Messages"],"parameters":[{"name":"city","in":"query","description":"Filter by full name of city messages were clicked in i.e. Minneapolis Philadelphia","schema":{"type":"string","example":""}},{"name":"client_company","in":"query","description":"Filter by company i.e.Microsoft Apple Google","schema":{"type":"string","example":""}},{"name":"client_family","in":"query","description":"Filter by client family i.e.OS X Chrome","schema":{"type":"string","example":""}},{"name":"client_name","in":"query","description":"Filter by client name i.e.Outlook Gmail","schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"Number of message clicks to return per request Max 500","required":true,"schema":{"type":"string","example":""}},{"name":"country","in":"query","description":"Filter by country messages were clicked in i.e. Denmark Russia","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream ID.If not provided message will default to the outbound transactional stream.","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of clicks to skip","required":true,"schema":{"type":"string","example":""}},{"name":"os_company","in":"query","description":"Filter by company which produced the OS i.e. Apple Computer Inc.Microsoft Corporation\nplatform","schema":{"type":"string","example":"","items":{"type":"string","enum":["string"]}}},{"name":"os_family","in":"query","description":"Filter by kind of OS used without specific version i.e. OS X Windows","schema":{"type":"string","example":""}},{"name":"os_name","in":"query","description":"Filter by full OS name and specific version i.e. OS X 10.9 Mavericks Windows 7","schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"Filter by To Cc Bcc","schema":{"type":"string","example":""}},{"name":"region","in":"query","description":"Filter by full name of region messages were clicked in i.e. Moscow New York","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#message-clicks","api_endpoint":"https://api.postmarkapp.com/messages/outbound/clicks"},"summary":"Message clicks","description":"Message clicks","security":[{"bearerAuth":[]}]}},"/messages/outbound/clicks/{messageid}":{"get":{"tags":["Messages"],"parameters":[{"name":"messageid","in":"path","description":"Message ID","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"Number of message clicks to return per request.Max 500","required":true,"schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of messages to skip","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/messages-api#clicks-for-message","api_endpoint":"https://api.postmarkapp.com/messages/outbound/clicks/{messageid}"},"summary":"Clicks for a single message","description":"Clicks for a single message","security":[{"bearerAuth":[]}]}},"/senders":{"get":{"tags":["Sender Signatures"],"parameters":[{"name":"count","in":"query","description":"Number of records to return per request.Max 500","required":true,"schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of records to skip.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#list-sender-signatures","api_endpoint":"https://api.postmarkapp.com/senders"},"summary":"List sender signatures","description":"List sender signatures","security":[{"bearerAuth":[]}]},"post":{"tags":["Sender Signatures"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#create-signature","api_endpoint":"https://api.postmarkapp.com/senders"},"summary":"Create a signature","description":"Create a signature","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"FromEmail":{"type":"string","description":"From email associated with sender signature","required":true},"Name":{"type":"string","description":"From name associated with sender signature","required":true},"ReplyToEmail":{"type":"string","description":"Override for reply-to address"},"ReturnPathDomain":{"type":"string","description":"A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net"}}},"example":{"FromEmail":"john.doe@example.com","Name":"John Doe","ReplyToEmail":"reply@example.com","ReturnPathDomain":"pm-bounces.example.com"}}}}}},"/senders/{signatureid}":{"get":{"tags":["Sender Signatures"],"parameters":[{"name":"signatureid","in":"path","description":"Signature ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#sender-signature","api_endpoint":"https://api.postmarkapp.com/senders/{signatureid}"},"summary":"Get a sender signature’s details","description":"Get a sender signature’s details","security":[{"bearerAuth":[]}]},"put":{"tags":["Sender Signatures"],"parameters":[{"name":"signatureid","in":"path","description":"Signature ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#edit-signature","api_endpoint":"https://api.postmarkapp.com/senders/{signatureid}"},"summary":"Edit a signature","description":"Edit a signature","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ConfirmationPersonalNote":{"type":"string","description":"A way to provide a note to the recipient of the confirmation email to have context of what Postmark is.Max length of 400 characters."},"Name":{"type":"string","description":"From name associated with sender signature","required":true},"ReplyToEmail":{"type":"string","description":"Override for reply-to address"},"ReturnPathDomain":{"type":"string","description":"A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net.For more information about this field please read our support page"}}},"example":{"ConfirmationPersonalNote":"This is a note visible to the recipient to provide context of what Postmark is.","Name":"John Doe","ReplyToEmail":"jane.doe@example.com","ReturnPathDomain":"pm-bounces.example.com"}}}}},"delete":{"tags":["Sender Signatures"],"parameters":[{"name":"signatureid","in":"path","description":"Signature ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#delete-signature","api_endpoint":"https://api.postmarkapp.com/senders/{signatureid}"},"summary":"Delete a signature","description":"Delete a signature","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/senders/{signatureid}/resend":{"post":{"tags":["Sender Signatures"],"parameters":[{"name":"signatureid","in":"path","description":"Signature ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#resend-confirmation","api_endpoint":"https://api.postmarkapp.com/senders/{signatureid}/resend"},"summary":"Resend a confirmation","description":"Resend a confirmation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/senders/{signatureid}/requestnewdkim":{"post":{"tags":["Sender Signatures"],"parameters":[{"name":"signatureid","in":"path","description":"Signature ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/signatures-api#request-dkim","api_endpoint":"https://api.postmarkapp.com/senders/{signatureid}/requestnewdkim"},"summary":"Request a new DKIM","description":"Request a new DKIM","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/server":{"get":{"tags":["Server"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/server-api#get-server","api_endpoint":"https://api.postmarkapp.com/server"},"summary":"Get the server","description":"Get the server","security":[{"bearerAuth":[]}]},"put":{"tags":["Server"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/server-api#edit-server","api_endpoint":"https://api.postmarkapp.com/server"},"summary":"Edit the server","description":"Edit the server","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BounceHookUrl":{"type":"string","description":"URL to POST to every time a bounce event occurs"},"ClickHookUrl":{"type":"string","description":"URL to POST to when a unique click event occurs"},"Color":{"type":"string","description":"Color of the server in the rack screen.Purple Blue Turquoise Green Red Yellow Grey Orange"},"DeliveryHookUrl":{"type":"string","description":"URL to POST to every time email is delivered"},"EnableSmtpApiErrorHooks":{"type":"boolean","description":"Specifies whether or not SMTP API Errors will be included with bounce webhooks.","enum":[true,false]},"InboundDomain":{"type":"string","description":"Inbound domain for MX setup"},"InboundHookUrl":{"type":"string","description":"URL to POST to every time an inbound event occurs"},"InboundSpamThreshold":{"type":"number","description":"The maximum spam score for an inbound message before it's blocked"},"IncludeBounceContentInHook":{"type":"boolean","description":"Include bounce content in webhook","enum":[true,false]},"Name":{"type":"string","description":"Name of server"},"OpenHookUrl":{"type":"string","description":"URL to POST to every time an open event occurs"},"PostFirstOpenOnly":{"type":"boolean","description":"If set to true only the first open by a particular recipient will initiate the open webhook.Any subsequent opens of the same email by the same recipient will not initiate the webhook.\nTrackOpens","enum":[true,false]},"RawEmailEnabled":{"type":"boolean","description":"When enabled the raw email content will be included with inbound webhook payloads under the RawEmail key","enum":[true,false]},"SmtpApiActivated":{"type":"boolean","description":"Specifies whether or not SMTP is enabled on this server","enum":[true,false]},"TrackLinks":{"type":"string","description":"Indicates if all emails being sent through this server should have link tracking enabled for links in their HTML or Text bodies.Possible options;None HtmlAndText HtmlOnly TextOnly"}}},"example":{"BounceHookUrl":"http://hooks.example.com/bounce","ClickHookUrl":"http://hooks.example.com/click","Color":"blue","DeliveryHookUrl":"http://hooks.example.com/delivery","EnableSmtpApiErrorHooks":"","InboundDomain":"","InboundHookUrl":"http://hooks.example.com/inbound","InboundSpamThreshold":10,"IncludeBounceContentInHook":"","Name":"Production 2","OpenHookUrl":"http://hooks.example.com/open","PostFirstOpenOnly":"","RawEmailEnabled":"","SmtpApiActivated":"","TrackLinks":"None"}}}}}},"/servers/{serverid}":{"get":{"tags":["Servers"],"parameters":[{"name":"serverid","in":"path","description":"Server ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/servers-api#get-server","api_endpoint":"https://api.postmarkapp.com/servers/{serverid}"},"summary":"Get a server","description":"Get a server","security":[{"bearerAuth":[]}]},"put":{"tags":["Servers"],"parameters":[{"name":"serverid","in":"path","description":"Server ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/servers-api#edit-server","api_endpoint":"https://api.postmarkapp.com/servers/{serverid}"},"summary":"Edit a server","description":"Edit a server","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Color":{"type":"string","description":"Color of the server in the server list for quick identification.Purple Blue Turquoise Green Red Yellow Grey Orange"},"EnableSmtpApiErrorHooks":{"type":"boolean","description":"Specifies whether or not SMTP API Errors will be included with bounce webhooks.","enum":[true,false]},"InboundDomain":{"type":"string","description":"Inbound domain for MX setup"},"InboundHookUrl":{"type":"string","description":"URL to POST to every time an inbound event occurs"},"InboundSpamThreshold":{"type":"number","description":"The maximum spam score for an inbound message before it's blocked"},"IncludeBounceContentInHook":{"type":"boolean","description":"Include bounce content in webhook","enum":[true,false]},"Name":{"type":"string","description":"Name of server"},"PostFirstOpenOnly":{"type":"boolean","description":"If set to true only the first open by a particular recipient will initiate the open webhook.Any subsequent opens of the same email by the same recipient will not initiate the webhook","enum":[true,false]},"RawEmailEnabled":{"type":"boolean","description":"When enabled the raw email content will be included with inbound webhook payloads under the RawEmail key","enum":[true,false]},"SmtpApiActivated":{"type":"boolean","description":"Specifies whether or not SMTP is enabled on this server","enum":[true,false]},"TrackLinks":{"type":"string","description":"Indicates if all emails being sent through this server should have link tracking enabled for links in their HTML or Text bodies.Possible options; None HtmlAndText HtmlOnly TextOnly"},"TrackOpens":{"type":"boolean","description":"Indicates if all emails being sent through this server have open tracking enabled","enum":[true,false]}}},"example":{"Color":"blue","EnableSmtpApiErrorHooks":"","InboundDomain":"","InboundHookUrl":"http://hooks.example.com/inbound","InboundSpamThreshold":"","IncludeBounceContentInHook":true,"Name":"Production 2","PostFirstOpenOnly":"","RawEmailEnabled":"","SmtpApiActivated":"","TrackLinks":"None","TrackOpens":""}}}}},"delete":{"tags":["Servers"],"parameters":[{"name":"serverid","in":"path","description":"Server ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/servers-api#delete-server","api_endpoint":"https://api.postmarkapp.com/servers/{serverid}"},"summary":"Delete a server","description":"Delete a server","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/servers":{"post":{"tags":["Servers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/servers-api#create-server","api_endpoint":"https://api.postmarkapp.com/servers"},"summary":"Create a server","description":"Create a server","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Color":{"type":"string","description":"Color of the server in the server list for quick identification.Purple Blue Turquoise Green Red Yellow Grey Orange"},"DeliveryType":{"type":"string","description":"Specifies the type of environment for your server.Possible options; Live Sandbox.Defaults to Live if not specified.This cannot be changed after the server has been created"},"EnableSmtpApiErrorHooks":{"type":"boolean","description":"Specifies whether or not SMTP API Errors will be included with bounce webhooks.","enum":[true,false]},"InboundDomain":{"type":"string","description":"Inbound domain for MX setup"},"InboundHookUrl":{"type":"string","description":"URL to POST to every time an inbound event occurs"},"InboundSpamThreshold":{"type":"number","description":"The maximum spam score for an inbound message before it's blocked"},"IncludeBounceContentInHook":{"type":"boolean","description":"Include bounce content in webhook","enum":[true,false]},"Name":{"type":"string","description":"Name of server","required":true},"PostFirstOpenOnly":{"type":"boolean","description":"If set to true only the first open by a particular recipient will initiate the open webhook.Any subsequent opens of the same email by the same recipient will not initiate the webhook","enum":[true,false]},"RawEmailEnabled":{"type":"boolean","description":"When enabled the raw email content will be included with inbound webhook payloads under the RawEmail key","enum":[true,false]},"SmtpApiActivated":{"type":"boolean","description":"Specifies whether or not SMTP is enabled on this server","enum":[true,false]},"TrackLinks":{"type":"string","description":"Indicates if all emails being sent through this server should have link tracking enabled for links in their HTML or Text bodies.Possible options; None HtmlAndText HtmlOnly TextOnly"},"TrackOpens":{"type":"boolean","description":"Indicates if all emails being sent through this server have open tracking enabled","enum":[true,false]}}},"example":{"Color":"red","DeliveryType":"Live","EnableSmtpApiErrorHooks":"","InboundDomain":"","InboundHookUrl":"http://hooks.example.com/inbound","InboundSpamThreshold":5,"IncludeBounceContentInHook":true,"Name":"Staging Testing","PostFirstOpenOnly":"","RawEmailEnabled":"","SmtpApiActivated":true,"TrackLinks":"None","TrackOpens":""}}}}},"get":{"tags":["Servers"],"parameters":[{"name":"count","in":"query","description":"Number of servers to return per request","required":true,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"Filter by a specific server name","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Number of servers to skip","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/servers-api#list-servers","api_endpoint":"https://api.postmarkapp.com/servers"},"summary":"List servers","description":"List servers","security":[{"bearerAuth":[]}]}},"/stats/outbound":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream.If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#overview","api_endpoint":"https://api.postmarkapp.com/stats/outbound"},"summary":"Get outbound overview","description":"Get outbound overview","security":[{"bearerAuth":[]}]}},"/stats/outbound/sends":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#sent-counts","api_endpoint":"https://api.postmarkapp.com/stats/outbound/sends"},"summary":"Get sent counts","description":"Get sent counts","security":[{"bearerAuth":[]}]}},"/stats/outbound/bounces":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#bounce-counts","api_endpoint":"https://api.postmarkapp.com/stats/outbound/bounces"},"summary":"Get bounce counts","description":"Get bounce counts","security":[{"bearerAuth":[]}]}},"/stats/outbound/spam":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01\nmessagestream","schema":{"type":"string","example":"","items":{"type":"string","enum":["string"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#spam-complaints","api_endpoint":"https://api.postmarkapp.com/stats/outbound/spam"},"summary":"Get spam complaints","description":"Get spam complaints","security":[{"bearerAuth":[]}]}},"/stats/outbound/tracked":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#email-tracked-count","api_endpoint":"https://api.postmarkapp.com/stats/outbound/tracked"},"summary":"Get tracked email counts","description":"Get tracked email counts","security":[{"bearerAuth":[]}]}},"/stats/outbound/opens":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#email-open-counts","api_endpoint":"https://api.postmarkapp.com/stats/outbound/opens"},"summary":"Get email open counts","description":"Get email open counts","security":[{"bearerAuth":[]}]}},"/stats/outbound/opens/platforms":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#email-platform-usage","api_endpoint":"https://api.postmarkapp.com/stats/outbound/opens/platforms"},"summary":"Get email platform usage","description":"Get email platform usage","security":[{"bearerAuth":[]}]}},"/stats/outbound/opens/emailclients":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#email-client-usage","api_endpoint":"https://api.postmarkapp.com/stats/outbound/opens/emailclients"},"summary":"Get email client usage","description":"Get email client usage","security":[{"bearerAuth":[]}]}},"/stats/outbound/clicks":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://api.postmarkapp.com/stats/outbound/clicks?fromdate=2014-01-01&todate=2014-02-01","api_endpoint":"https://api.postmarkapp.com/stats/outbound/clicks"},"summary":"Get click counts","description":"Get click counts","security":[{"bearerAuth":[]}]}},"/stats/outbound/clicks/browserfamilies":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#browser-usage","api_endpoint":"https://api.postmarkapp.com/stats/outbound/clicks/browserfamilies"},"summary":"Get browser usage","description":"Get browser usage","security":[{"bearerAuth":[]}]}},"/stats/outbound/clicks/platforms":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#browser-platform-usage","api_endpoint":"https://api.postmarkapp.com/stats/outbound/clicks/platforms"},"summary":"Get browser platform usage","description":"Get browser platform usage","security":[{"bearerAuth":[]}]}},"/stats/outbound/clicks/location":{"get":{"tags":["Stats"],"parameters":[{"name":"fromdate","in":"query","description":"Filter stats starting from the date specified (inclusive). e.g. 2014-01-01","schema":{"type":"string","example":""}},{"name":"messagestream","in":"query","description":"Filter by message stream. If not provided the response will include stats for all streams in the server.","schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"Filter by tag","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter stats up to the date specified (inclusive). e.g. 2014-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/stats-api#click-location","api_endpoint":"https://api.postmarkapp.com/stats/outbound/clicks/location"},"summary":"Get click location","description":"Get click location","security":[{"bearerAuth":[]}]}},"/message-streams/{stream_id}/suppressions/dump":{"get":{"tags":["Suppressions"],"parameters":[{"name":"stream_ID","in":"path","description":" Stream ID","required":true,"schema":{"type":"string","example":""}},{"name":"EmailAddress","in":"query","description":"Filter by email address.","schema":{"type":"string","example":""}},{"name":"Origin","in":"query","description":"Filter by origin of how the address was added to suppression list. Possible options; Recipient Customer Admin","schema":{"type":"string","example":""}},{"name":"SuppressionReason","in":"query","description":"Filter by suppression reason. Possible options; HardBounce SpamComplaint ManualSuppression","schema":{"type":"string","example":""}},{"name":"fromdate","in":"query","description":"Filter suppressions up to the date specified (inclusive) e.g. 2020-02-01","schema":{"type":"string","example":""}},{"name":"todate","in":"query","description":"Filter suppressions up to the date specified (inclusive) e.g. 2020-02-01","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/suppressions-api#suppression-dump","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_id}/suppressions/dump"},"summary":"Suppression dump","description":"Suppression dump ","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"stream_ID","in":"path","description":" Stream ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/suppressions-api#create-a-suppression","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_id}/suppressions/dump"},"summary":"Create a Suppression","description":"Create a Suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EmailAddress":{"type":"string","description":"The email address to request suppression creation on."},"Suppressions":{"type":"array​","description":"An ​array that will contain that email addresses to create a suppression on.Max of 50 suppressions that can be created in one call","required":true}}},"example":{"EmailAddress":"","Suppressions":[{"EmailAddress":"good.address@wildbit.com"},{"EmailAddress":"spammy.address@wildbit.com"},{"EmailAddress":"invalid-email-address"}]}}}}}},"/message-streams/{stream_id}/suppressions/delete":{"delete":{"tags":["Suppressions"],"parameters":[{"name":"stream_ID","in":"path","description":" Stream ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/suppressions-api#delete-a-suppression","api_endpoint":"https://api.postmarkapp.com/message-streams/{stream_id}/suppressions/delete"},"summary":"Delete a Suppression","description":"Delete a Suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EmailAddress":{"type":"string","description":"The email address to request suppression deletion on."},"Suppressions":{"type":"array​","description":"An ​array of email addresses to delete a suppression on.Max of 50 suppressions that can be removed in one call","required":true}}},"example":{"EmailAddress":"","Suppressions":[{"EmailAddress":"good.address@wildbit.com"},{"EmailAddress":"not.suppressed@wildbit.com"},{"EmailAddress":"spammy.address@wildbit.com"}]}}}}}},"/email/withTemplate":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#email-with-template","api_endpoint":"https://api.postmarkapp.com/email/withTemplate"},"summary":"Send email with template","description":"Send email with template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Attachments":{"type":"array","description":"List of attachments","items":{"type":"string"}},"Bcc":{"type":"string","description":"Bcc recipient email address.Multiple addresses are comma separated. Max 50"},"Cc":{"type":"string","description":"Cc recipient email address.Multiple addresses are comma separated. Max 50"},"From":{"type":"string","description":"The sender email address. Must have a registered and confirmed Sender Signature. To include a name use the format \"Full Name <sender@domain.com>\" for the address","required":true},"Headers":{"type":"array","description":"List of custom headers to include","items":{"type":"string"}},"InlineCss":{"type":"boolean","description":"By default, if the specified template contains an HTMLBody, we will apply the style blocks as inline attributes to the rendered HTML content. You may opt-out of this behavior by passing false for this request field.","enum":[true,false]},"MessageStream":{"type":"string","description":"Set message stream ID that's used for sending. If not provided message will default to the outbound transactional stream"},"Metadata":{"type":"object","description":"Custom metadata key/value pairs","properties":{}},"ReplyTo":{"type":"string","description":"Reply To override email address.Defaults to the Reply To set in the sender signature"},"Tag":{"type":"string","description":"Email tag that allows you to categorize outgoing emails and get detailed statistics"},"TemplateAlias":{"type":"string","description":"The alias of a template to use when sending this message.Required if TemplateId is not specified","required":true},"TemplateId":{"type":"number","description":"The template to use when sending this message.Required if TemplateAlias is not specified","required":true},"TemplateModel":{"type":"object","description":"The model to be applied to the specified template to generate HtmlBody TextBody and Subject","required":true,"properties":{}},"To":{"type":"string","description":"Recipient email address.Multiple addresses are comma separated. Max 50","required":true},"TrackLinks":{"type":"string","description":"Activate link tracking for links in the HTML or Text bodies of this email.Possible options; None HtmlAndText HtmlOnly TextOnly"},"TrackOpens":{"type":"boolean","description":"Activate open tracking for this email","enum":[true,false]}}},"example":{"Attachments":[{"Content":"dGVzdCBjb250ZW50","ContentType":"text/plain","Name":"readme.txt"},{"Content":"dGVzdCBjb250ZW50","ContentType":"application/octet-stream","Name":"report.pdf"}],"Bcc":"blank-copied@example.com","Cc":"copied@example.com","From":"sender@example.com","Headers":[{"Name":"CUSTOM-HEADER","Value":"value"}],"InlineCss":true,"MessageStream":"outbound","Metadata":{"client-id":"12345","color":"blue"},"ReplyTo":"reply@example.com","Tag":"Invitation","TemplateAlias":"","TemplateId":1234,"TemplateModel":{"company":{"name":"ACME"},"user_name":"John Smith"},"To":"receiver@example.com","TrackLinks":"None","TrackOpens":true}}}}}},"/email/batchWithTemplates":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#send-batch-with-templates","api_endpoint":"https://api.postmarkapp.com/email/batchWithTemplates"},"summary":"Send batch with templates","description":"Send batch with templates","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Attachments":{"type":"array","description":"List of attachments","items":{"type":"string"}},"Bcc":{"type":"string","description":"Bcc recipient email address.Multiple addresses are comma separated.Max 50"},"Cc":{"type":"string","description":"Cc recipient email address.Multiple addresses are comma separated.Max 50"},"From":{"type":"string","description":"The sender email address.Must have a registered and confirmed Sender Signature. To include a name use the format \"Full Name <sender@domain.com>\" for the address","required":true},"Headers":{"type":"array","description":"List of custom headers to include","items":{"type":"string"}},"MessageStream":{"type":"string","description":"Set message stream ID that's used for sending.If not provided message will default to the outbound transactional stream."},"Messages":{"type":"array","description":"The list of templates to send.Please note that we accept up to 500 messages per API call","required":true,"items":{"type":"string"}},"Metadata":{"type":"object","description":"Custom metadata key/value pairs","properties":{}},"ReplyTo":{"type":"string","description":"Reply To override email address.Defaults to the Reply To set in the sender signature"},"Tag":{"type":"string","description":"Email tag that allows you to categorize outgoing emails and get detailed statistics"},"TemplateAlias":{"type":"string","description":"The template to use for this message.This value is required if TemplateId is not supplied.If both are supplied TemplateId will be used to select the template"},"TemplateId":{"type":"number","description":"The template to use for this message.This value is required if TemplateAlias is not supplied.If both are supplied TemplateId will be used to select the template"},"To":{"type":"string","description":"Recipient email address.Multiple addresses are comma separated. Max 50","required":true},"TrackLinks":{"type":"string","description":"Activate link tracking for links in the HTML or Text bodies of this email.Possible options","enum":["None HtmlAndText HtmlOnly TextOnly"]},"TrackOpens":{"type":"boolean","description":"Activate open tracking for this email.","enum":[true,false]}}},"example":{"Attachments":[],"Bcc":"","Cc":"","From":"","Headers":[],"MessageStream":"","Messages":[{"Attachments":[{"Content":"dGVzdCBjb250ZW50","ContentType":"text/plain","Name":"readme.txt"},{"Content":"dGVzdCBjb250ZW50","ContentType":"application/octet-stream","Name":"report.pdf"},{"Content":"dGVzdCBjb250ZW50","ContentID":"cid:image.jpg","ContentType":"image/jpeg","Name":"image.jpg"}],"Bcc":"blank-copied@example.com","Cc":"copied@example.com","From":"sender@example.com","Headers":[{"Name":"CUSTOM-HEADER","Value":"value"}],"MessageStream":"outbound","Metadata":{"client-id":"12345","color":"blue"},"ReplyTo":"reply@example.com","Tag":"Invitation","TemplateAlias":"invitation-letter","TemplateModel":{"fizz":"buzz"},"To":"receiver@example.com","TrackLinks":"None","TrackOpens":true}],"Metadata":{},"ReplyTo":"","Tag":"","TemplateAlias":"","TemplateId":"","To":"","TrackLinks":"","TrackOpens":""}}}}}},"/templates/push":{"put":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#push-templates","api_endpoint":"https://api.postmarkapp.com/templates/push"},"summary":"Push templates to another server","description":"Push templates to another server","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DestinationServerID":{"type":"string","description":"Server ID of the destination server receiving the pushed templates","required":true},"PerformChanges":{"type":"boolean","description":"Specifies whether to push templates to destination server or not. This parameter can be set to false to allow you to do a \"dry-run\" of the push operation so that you can see which templates would be created or updated from this operation.","required":true,"enum":[true,false]},"SourceServerID":{"type":"string","description":"Server ID of the source server containing the templates that will be pushed","required":true}}},"example":{"DestinationServerID":997285,"PerformChanges":true,"SourceServerID":997287}}}}}},"/templates/{templateIdOrAlias}":{"get":{"tags":["Templates"],"parameters":[{"name":"templateIdOrAlias","in":"path","description":"Template ID Or Alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#get-template","api_endpoint":"https://api.postmarkapp.com/templates/{templateIdOrAlias}"},"summary":"Get a template","description":"Get a template","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"templateIdOrAlias","in":"path","description":"Template ID Or Alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#edit-template","api_endpoint":"https://api.postmarkapp.com/templates/{templateIdOrAlias}"},"summary":"Edit a template","description":"Edit a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Alias":{"type":"string","description":"An optional string you can provide to identify this Template.Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter"},"HtmlBody":{"type":"string","description":"The content to use for the HtmlBody when this template is used to send email.Required if TextBody is not specified.See our template language documentation for more information on the syntax for this field","required":true},"LayoutTemplate":{"type":"string","description":"An optional string to specify which Layout Template to use (via layout alias) for an existing Layout Template when creating a standard template.Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter.The API will throw an error if LayoutTemplate is present and the template type is a Layout. This field can also be set to null by using an empty string \"\"."},"Name":{"type":"string","description":"Name of template","required":true},"Subject":{"type":"string","description":"The content to use for the Subject when this template is used to send email. See our template language documentation for more information on the syntax for this field.","required":true},"TextBody":{"type":"string","description":"The content to use for the TextBody when this template is used to send email. Required if HtmlBody is not specified. See our template language documentation for more information on the syntax for this field","required":true}}},"example":{"Alias":"welcome-v1","HtmlBody":"<html><body>Hello, {{name}}!</body></html>","LayoutTemplate":"my-layout","Name":"Onboarding Email","Subject":"Hello from {{company.name}}!","TextBody":"Hello, {{name}}!"}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"templateIdOrAlias","in":"path","description":"Template ID Or Alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#delete-template","api_endpoint":"https://api.postmarkapp.com/templates/{templateIdOrAlias}"},"summary":"Delete a template","description":"Delete a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/templates":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#create-template","api_endpoint":"https://api.postmarkapp.com/templates"},"summary":"Create a template","description":"Create a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Alias":{"type":"string","description":"An optional string you can provide to identify this template (if creating a standard template).Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter"},"HtmlBody":{"type":"string","description":"The content to use for the HtmlBody when this template is used to send email.Required if TextBody is not specified.See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present for a layout template and can be placed only once in the HtmlBody","required":true},"LayoutTemplate":{"type":"string","description":"An optional string to specify which Layout Template to use (via layout alias) for an existing Layout Template when creating a standard template Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter.The API will throw an error if LayoutTemplate is present and the template type is a Layout.This field can also be set to null by using an empty string \"\"."},"Name":{"type":"string","description":"Name of template","required":true},"Subject":{"type":"string","description":"The content to use for the Subject when this template is used to send email.Subject is only required on standard templates.See our template language documentation for more information on the syntax for this field.Subjects are not allowed for layout templates and will result in an API error","required":true},"TemplateType":{"type":"string","description":"Available when creating a template.To set if a template is standard template or layout template.Possible options; Standard or Layout.Defaults to Standard.After creation it's not possible to change a template type"},"TextBody":{"type":"string","description":"The content to use for the TextBody when this template is used to send email. Required if HtmlBody is not specified. See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present for a layout template and can be placed only once in the TextBody","required":true}}},"example":{"Alias":"onboarding-v1","HtmlBody":"<html><body>Hello, {{name}}!</body></html>","LayoutTemplate":"my-layout","Name":"Onboarding Email","Subject":"Hello from {{company.name}}!","TemplateType":"Standard","TextBody":"Hello, {{name}}!"}}}}},"get":{"tags":["Templates"],"parameters":[{"name":"Count","in":"query","description":"The number of templates to return","required":true,"schema":{"type":"string","example":""}},{"name":"LayoutTemplate","in":"query","description":"Filter results by layout alias.","schema":{"type":"string","example":""}},{"name":"Offset","in":"query","description":"The number of templates to \"skip\" before returning results","required":true,"schema":{"type":"string","example":""}},{"name":"TemplateType","in":"query","description":"Filters templates based on template type (layout template or standard template).Possible options; All Standard Layout.Defaults to All","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#list-templates","api_endpoint":"https://api.postmarkapp.com/templates"},"summary":"List templates","description":"List templates","security":[{"bearerAuth":[]}]}},"/templates/validate":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/templates-api#validate-template","api_endpoint":"https://api.postmarkapp.com/templates/validate"},"summary":"Validate a template","description":"Validate a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"HtmlBody":{"type":"string","description":"The HTML body content to validate.Must be specified if TextBody or Subject are not.See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present to validate a layout template and can be placed only once in the HtmlBody","required":true},"InlineCssForHtmlTestRender":{"type":"boolean","description":"When HtmlBody is specified the test render will have style blocks inlined as style attributes on matching html elements.You may disable the css inlining behavior by passing false for this parameter","enum":[true,false]},"LayoutTemplate":{"type":"string","description":"An optional string to specify which layout template alias to use to validate a standard template.If not provided a standard template will not use a layout template."},"Subject":{"type":"string","description":"The subject content to validate.Must be specified if HtmlBody or TextBody are not.See our template language documentation for more information on the syntax for this field","required":true},"TemplateType":{"type":"string","description":"Validates templates based on template type (layout template or standard template).Possible options; Standard or Layout.Defaults to Standard"},"TestRenderModel":{"type":"object","description":"The template model to be used when rendering test content","properties":{}},"TextBody":{"type":"string","description":"The plain text body content to validate.Must be specified if Subject or HtmlBody are not.See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present to validate a layout template and can be placed only once in the TextBody","required":true}}},"example":{"HtmlBody":"{{#company}}{{address}}{{/company}}{{#each person}} {{name}} {{/each}}","InlineCssForHtmlTestRender":"","LayoutTemplate":"my-layout","Subject":"{{#company}}{{name}}{{/company}} {{subjectHeadline}}","TemplateType":"Standard","TestRenderModel":{"userName":"bobby joe"},"TextBody":"{{#company}}{{phone}}{{/company}}{{#each person}} {{name}} {{/each}}"}}}}}},"/webhooks":{"get":{"tags":["Webhooks"],"parameters":[{"name":"MessageStream","in":"query","description":"Filter by message stream.If no stream is provided will return all webhooks for the server. If a non existing stream is provided an error is thrown instead of an empty webhooks array.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/webhooks-api#list-webhooks","api_endpoint":"https://api.postmarkapp.com/webhooks"},"summary":"List webhooks","description":"List webhooks","security":[{"bearerAuth":[]}]},"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/webhooks-api#create-a-webhook","api_endpoint":"https://api.postmarkapp.com/webhooks"},"summary":"Create a webhook","description":"Create a webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Bounce":{"type":"object","description":"Listing for if the Bounce webhook is enabled/disabled.Webhook will send full bounce content if IncludeContent is enabled","properties":{}},"Click":{"type":"object","description":"Listing for if the Click webhook is enabled/disabled","properties":{}},"Delivery":{"type":"object","description":"Listing for if the Delivery webhook is enabled/disabled","properties":{}},"HttpAuth":{"type":"object","description":"Custom HTTP Auth username/password pairs","properties":{}},"HttpHeaders":{"type":"array","description":"Custom HTTP Headers name/value pairs","items":{"type":"string"}},"MessageStream":{"type":"string","description":"The stream this webhook is associated with. If no MessageStream is provided the default transactional stream outbound will be used"},"Open":{"type":"object","description":"Listing for if the Open webhook is enabled/disabled.Webhook will only post on first open if PostFirstOpenOnly is enabled","properties":{}},"SpamComplaint":{"type":"object","description":"Listing for if the Spam webhook is enabled/disabled.Webhook will send full spam content if IncludeContent is enabled","properties":{}},"SubscriptionChange":{"type":"object","description":"Listing for if the Subscription Change webhook is enabled/disabled.","properties":{}},"Triggers":{"type":"object","description":"List of different webhooks events to enable","properties":{}},"Url":{"type":"string","description":"Your webhook URL","required":true}}},"example":{"Bounce":{},"Click":{},"Delivery":{},"HttpAuth":{"Password":"pass","Username":"user"},"HttpHeaders":[{"Name":"name","Value":"value"}],"MessageStream":"outbound","Open":{},"SpamComplaint":{},"SubscriptionChange":{},"Triggers":{"Bounce":{"Enabled":false,"IncludeContent":false},"Click":{"Enabled":true},"Delivery":{"Enabled":true},"Open":{"Enabled":true,"PostFirstOpenOnly":false},"SpamComplaint":{"Enabled":false,"IncludeContent":false},"SubscriptionChange":{"Enabled":false}},"Url":"http://www.example.com/webhook-test-tracking"}}}}}},"/webhooks/{Id}":{"get":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/webhooks-api#get-a-webhook","api_endpoint":"https://api.postmarkapp.com/webhooks/{Id}"},"summary":"Get a webhook","description":"Get a webhook","security":[{"bearerAuth":[]}]},"put":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/webhooks-api#edit-a-webhook","api_endpoint":"https://api.postmarkapp.com/webhooks/{Id}"},"summary":"Edit a webhook","description":"Edit a webhook ","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Bounce":{"type":"object","description":"Listing for if the Bounce webhook is enabled/disabled. Webhook will send full bounce content if IncludeContent is enabled","properties":{}},"Click":{"type":"object","description":"Listing for if the Click webhook is enabled/disabled","properties":{}},"Delivery":{"type":"object","description":"Listing for if the Delivery webhook is enabled/disabled","properties":{}},"HttpAuth":{"type":"object","description":"Optional.Add new Custom HTTP Auth username/password pairs","properties":{}},"HttpHeaders":{"type":"array","description":"Add new Custom HTTP Headers name/value pairs","items":{"type":"string"}},"Open":{"type":"object","description":"Listing for if the Open webhook is enabled/disabled. Webhook will only post on first open if PostFirstOpenOnly is enabled","properties":{}},"SpamComplaint":{"type":"object","description":"Listing for if the Spam webhook is enabled/disabled. Webhook will send full spam content if IncludeContent is enabled","properties":{}},"SubscriptionChange":{"type":"object","description":"Listing for if the Subscription Change webhook is enabled/disabled.","properties":{}},"Triggers":{"type":"object","description":"List of different webhooks events to enable/disable. If only click is provided the other events will not changed. If no triggers are provided there’ll be no change","properties":{}},"Url":{"type":"string","description":"Your new webhook URL"}}},"example":{"Bounce":{},"Click":{},"Delivery":{},"HttpAuth":{},"HttpHeaders":[],"Open":{},"SpamComplaint":{},"SubscriptionChange":{},"Triggers":{},"Url":""}}}}},"delete":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://postmarkapp.com/developer/api/webhooks-api#delete-a-webhook","api_endpoint":"https://api.postmarkapp.com/webhooks/{Id}"},"summary":"Delete a webhook","description":"Delete a webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}