openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 61.9 kB
JSON
{"openapi":"3.0.0","info":{"description":"Postmark makes sending and receiving email\nincredibly easy.\n","title":"Postmark API","version":"1.0.0","x-apisguru-categories":["email"],"x-logo":{"url":"https://pbs.twimg.com/profile_images/879295889185157120/ZYlwxzeY_400x400.jpg"},"x-origin":[{"format":"swagger","url":"https://postmarkapp.com/swagger/server.yml","version":"2.0"}],"x-providerName":"postmarkapp.com","x-serviceName":"server"},"paths":{"/bounces":{"get":{"operationId":"getBounces","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Number of bounces to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer","maximum":500}},{"description":"Number of bounces to skip.","in":"query","name":"offset","required":true,"schema":{"type":"integer"}},{"description":"Filter by type of bounce","in":"query","name":"type","schema":{"type":"string","enum":["HardBounce","Transient","Unsubscribe","Subscribe","AutoResponder","AddressChange","DnsError","SpamNotification","OpenRelayTest","Unknown","SoftBounce","VirusNotification","MailFrontier Matador.","BadEmailAddress","SpamComplaint","ManuallyDeactivated","Unconfirmed","Blocked","SMTPApiError","InboundError","DMARCPolicy","TemplateRenderingFailed"]}},{"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.","in":"query","name":"inactive","schema":{"type":"boolean"}},{"description":"Filter by email address","in":"query","name":"emailFilter","schema":{"type":"string","format":"email"}},{"description":"Filter by messageID","in":"query","name":"messageID","schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter messages up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}},{"description":"Filter messages starting from the date specified. e.g. `2014-02-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BounceSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get bounces","tags":["Bounces API"]}},"/bounces/{bounceid}":{"get":{"operationId":"getSingleBounce","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the bounce to retrieve.","in":"path","name":"bounceid","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BounceInfoResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a single bounce","tags":["Bounces API"]}},"/bounces/{bounceid}/activate":{"put":{"operationId":"activateBounce","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the Bounce to activate.","in":"path","name":"bounceid","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BounceActivationResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Activate a bounce","tags":["Bounces API"]}},"/bounces/{bounceid}/dump":{"get":{"parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID for the bounce dump to retrieve.","in":"path","name":"bounceid","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BounceDumpResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get bounce dump","tags":["Bounces API"]}},"/deliverystats":{"get":{"operationId":"getDeliveryStats","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryStatsResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get delivery stats","tags":["Bounces API"]}},"/email":{"post":{"operationId":"sendEmail","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Send a single email","tags":["Sending API"]}},"/email/batch":{"post":{"operationId":"sendEmailBatch","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailBatchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailBatchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Send a batch of emails","tags":["Sending API"]}},"/email/batchWithTemplates":{"post":{"operationId":"sendEmailBatchWithTemplates","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailTemplatedBatchRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailBatchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Send a batch of email using templates.","tags":["Sending API","Templates API"]}},"/email/withTemplate":{"post":{"operationId":"sendEmailWithTemplate","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailWithTemplateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Send an email using a Template","tags":["Sending API","Templates API"]}},"/messages/inbound":{"get":{"operationId":"searchInboundMessages","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Number of messages to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer"}},{"description":"Number of messages to skip","in":"query","name":"offset","required":true,"schema":{"type":"integer"}},{"description":"Filter by the user who was receiving the email","in":"query","name":"recipient","schema":{"type":"string","format":"email"}},{"description":"Filter by the sender email address","in":"query","name":"fromemail","schema":{"type":"string","format":"email"}},{"description":"Filter by email subject","in":"query","name":"subject","schema":{"type":"string"}},{"description":"Filter by mailboxhash","in":"query","name":"mailboxhash","schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`)","in":"query","name":"status","schema":{"type":"string","enum":["blocked","processed","queued","failed","scheduled"]}},{"description":"Filter messages up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}},{"description":"Filter messages starting from the date specified. e.g. `2014-02-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Inbound message search","tags":["Messages API"]}},"/messages/inbound/{messageid}/bypass":{"put":{"operationId":"bypassRulesForInboundMessage","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the message which should bypass inbound rules.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardPostmarkResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Bypass rules for a blocked inbound message","tags":["Messages API"]}},"/messages/inbound/{messageid}/details":{"get":{"operationId":"getInboundMessageDetails","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the message for which to details will be retrieved.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundMessageFullDetailsResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Inbound message details","tags":["Messages API"]}},"/messages/inbound/{messageid}/retry":{"put":{"operationId":"retryInboundMessageProcessing","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the inbound message on which we should retry processing.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardPostmarkResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retry a failed inbound message for processing","tags":["Messages API"]}},"/messages/outbound":{"get":{"operationId":"searchOutboundMessages","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Number of messages to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer"}},{"description":"Number of messages to skip","in":"query","name":"offset","required":true,"schema":{"type":"integer"}},{"description":"Filter by the user who was receiving the email","in":"query","name":"recipient","schema":{"type":"string","format":"email"}},{"description":"Filter by the sender email address","in":"query","name":"fromemail","schema":{"type":"string","format":"email"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter by status (`queued` or `sent`)","in":"query","name":"status","schema":{"type":"string","enum":["queued","sent"]}},{"description":"Filter messages up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}},{"description":"Filter messages starting from the date specified. e.g. `2014-02-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Outbound message search","tags":["Messages API"]}},"/messages/outbound/clicks":{"get":{"operationId":"searchClicksForOutboundMessages","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Number of message clicks to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer"}},{"description":"Number of messages to skip","in":"query","name":"offset","required":true,"schema":{"type":"integer"}},{"description":"Filter by To, Cc, Bcc","in":"query","name":"recipient","required":false,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"description":"Filter by client name, i.e. Outlook, Gmail","in":"query","name":"client_name","required":false,"schema":{"type":"string"}},{"description":"Filter by company, i.e. Microsoft, Apple, Google","in":"query","name":"client_company","required":false,"schema":{"type":"string"}},{"description":"Filter by client family, i.e. OS X, Chrome","in":"query","name":"client_family","required":false,"schema":{"type":"string"}},{"description":"Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7","in":"query","name":"os_name","required":false,"schema":{"type":"string"}},{"description":"Filter by kind of OS used without specific version, i.e. OS X, Windows","in":"query","name":"os_family","required":false,"schema":{"type":"string"}},{"description":"Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation","in":"query","name":"os_company","required":false,"schema":{"type":"string"}},{"description":"Filter by platform, i.e. webmail, desktop, mobile","in":"query","name":"platform","required":false,"schema":{"type":"string"}},{"description":"Filter by country messages were opened in, i.e. Denmark, Russia","in":"query","name":"country","required":false,"schema":{"type":"string"}},{"description":"Filter by full name of region messages were opened in, i.e. Moscow, New York","in":"query","name":"region","required":false,"schema":{"type":"string"}},{"description":"Filter by full name of region messages were opened in, i.e. Moscow, New York","in":"query","name":"city","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageClickSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Clicks for a all messages","tags":["Messages API"]}},"/messages/outbound/clicks/{messageid}":{"get":{"operationId":"getClicksForSingleOutboundMessage","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the Outbound Message for which click statistics should be retrieved.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}},{"description":"Number of message clicks to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer","minimum":1,"maximum":500,"default":1}},{"description":"Number of messages to skip.","in":"query","name":"offset","required":true,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageClickSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve Message Clicks","tags":["Messages API"]}},"/messages/outbound/opens":{"get":{"operationId":"searchOpensForOutboundMessages","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Number of message opens to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer"}},{"description":"Number of messages to skip","in":"query","name":"offset","required":true,"schema":{"type":"integer"}},{"description":"Filter by To, Cc, Bcc","in":"query","name":"recipient","required":false,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"description":"Filter by client name, i.e. Outlook, Gmail","in":"query","name":"client_name","required":false,"schema":{"type":"string"}},{"description":"Filter by company, i.e. Microsoft, Apple, Google","in":"query","name":"client_company","required":false,"schema":{"type":"string"}},{"description":"Filter by client family, i.e. OS X, Chrome","in":"query","name":"client_family","required":false,"schema":{"type":"string"}},{"description":"Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7","in":"query","name":"os_name","required":false,"schema":{"type":"string"}},{"description":"Filter by kind of OS used without specific version, i.e. OS X, Windows","in":"query","name":"os_family","required":false,"schema":{"type":"string"}},{"description":"Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation","in":"query","name":"os_company","required":false,"schema":{"type":"string"}},{"description":"Filter by platform, i.e. webmail, desktop, mobile","in":"query","name":"platform","required":false,"schema":{"type":"string"}},{"description":"Filter by country messages were opened in, i.e. Denmark, Russia","in":"query","name":"country","required":false,"schema":{"type":"string"}},{"description":"Filter by full name of region messages were opened in, i.e. Moscow, New York","in":"query","name":"region","required":false,"schema":{"type":"string"}},{"description":"Filter by full name of region messages were opened in, i.e. Moscow, New York","in":"query","name":"city","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageOpenSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Opens for all messages","tags":["Messages API"]}},"/messages/outbound/opens/{messageid}":{"get":{"operationId":"getOpensForSingleOutboundMessage","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the Outbound Message for which open statistics should be retrieved.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}},{"description":"Number of message opens to return per request. Max 500.","in":"query","name":"count","required":true,"schema":{"type":"integer","minimum":1,"maximum":500,"default":1}},{"description":"Number of messages to skip.","in":"query","name":"offset","required":true,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageOpenSearchResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve Message Opens","tags":["Messages API"]}},"/messages/outbound/{messageid}/details":{"get":{"operationId":"getOutboundMessageDetails","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the message for which to retrieve details.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundMessageDetailsResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Outbound message details","tags":["Messages API"]}},"/messages/outbound/{messageid}/dump":{"get":{"operationId":"getOutboundMessageDump","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the message for which to retrieve a dump.","in":"path","name":"messageid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundMessageDumpResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Outbound message dump","tags":["Messages API"]}},"/server":{"get":{"operationId":"getCurrentServerConfiguration","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerConfigurationResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get Server Configuration","tags":["Server Configuration API"]},"put":{"operationId":"editCurrentServerConfiguration","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditServerConfigurationRequest"}}},"description":"The settings that should be modified for the current server."},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerConfigurationResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Edit Server Configuration","tags":["Server Configuration API"]}},"/stats/outbound":{"get":{"operationId":"getOutboundOverviewStatistics","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundOverviewStatsResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get outbound overview","tags":["Stats API"]}},"/stats/outbound/bounces":{"get":{"operationId":"getBounceCounts","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"Days":{"items":{"properties":{"Date":{"type":"string"},"HardBounce":{"type":"integer"},"SMTPApiError":{"type":"integer"},"SoftBounce":{"type":"integer"},"Transient":{"type":"integer"}}},"type":"array"},"HardBounce":{"type":"integer"},"SMTPApiError":{"type":"integer"},"SoftBounce":{"type":"integer"},"Transient":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get bounce counts","tags":["Stats API"]}},"/stats/outbound/clicks":{"get":{"operationId":"getOutboundClickCounts","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get click counts","tags":["Stats API"]}},"/stats/outbound/clicks/browserfamilies":{"get":{"operationId":"getOutboundClickCountsByBrowserFamily","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get browser usage by family","tags":["Stats API"]}},"/stats/outbound/clicks/location":{"get":{"operationId":"getOutboundClickCountsByLocation","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get clicks by body location","tags":["Stats API"]}},"/stats/outbound/clicks/platforms":{"get":{"operationId":"getOutboundClickCountsByPlatform","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get browser plaform usage","tags":["Stats API"]}},"/stats/outbound/opens":{"get":{"operationId":"getOutboundOpenCounts","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"Days":{"items":{"properties":{"Date":{"type":"string"},"Opens":{"type":"integer"},"Unique":{"type":"integer"}}},"type":"array"},"Opens":{"type":"integer"},"Unique":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get email open counts","tags":["Stats API"]}},"/stats/outbound/opens/emailclients":{"get":{"operationId":"getOutboundOpenCountsByEmailClient","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"Days":{"items":{"$ref":"#/components/schemas/DynamicResponse"},"type":"array"},"Desktop":{"type":"integer"},"Mobile":{"type":"integer"},"Unknown":{"type":"integer"},"WebMail":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get email client usage","tags":["Stats API"]}},"/stats/outbound/opens/platforms":{"get":{"operationId":"getOutboundOpenCountsByPlatform","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"Days":{"items":{"properties":{"Date":{"type":"string"},"Desktop":{"type":"integer"},"Mobile":{"type":"integer"},"Unknown":{"type":"integer"},"WebMail":{"type":"integer"}}},"type":"array"},"Desktop":{"type":"integer"},"Mobile":{"type":"integer"},"Unknown":{"type":"integer"},"WebMail":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get email platform usage","tags":["Stats API"]}},"/stats/outbound/sends":{"get":{"operationId":"getSentCounts","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentCountsResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get sent counts","tags":["Stats API"]}},"/stats/outbound/spam":{"get":{"operationId":"getSpamComplaints","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats up to the date specified. e.g. `2014-02-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"Days":{"items":{"properties":{"Date":{"type":"string"},"SpamComplaint":{"type":"integer"}}},"type":"array"},"SpamComplaint":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get spam complaints","tags":["Stats API"]}},"/stats/outbound/tracked":{"get":{"operationId":"getTrackedEmailCounts","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Filter by tag","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"fromdate","schema":{"type":"string","format":"date"}},{"description":"Filter stats starting from the date specified. e.g. `2014-01-01`","in":"query","name":"todate","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"Days":{"items":{"properties":{"Date":{"type":"string"},"Tracked":{"type":"integer"}}},"type":"array"},"Tracked":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get tracked email counts","tags":["Stats API"]}},"/templates":{"get":{"operationId":"listTemplates","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The number of Templates to return","in":"query","name":"Count","required":true,"schema":{"type":"number","format":"int"}},{"description":"The number of Templates to \"skip\" before returning results.","in":"query","name":"Offset","required":true,"schema":{"type":"number","format":"int"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateListingResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get the Templates associated with this Server","tags":["Templates API"]},"post":{"parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTemplateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateRecordResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a Template","tags":["Templates API"]}},"/templates/validate":{"post":{"operationId":"testTemplateContent","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateValidationRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateValidationResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Test Template Content","tags":["Templates API"]}},"/templates/{templateIdOrAlias}":{"delete":{"operationId":"deleteTemplate","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The 'TemplateID' or 'Alias' value for the Template you wish to delete.","in":"path","name":"templateIdOrAlias","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDetailResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a Template","tags":["Templates API"]},"get":{"operationId":"getSingleTemplate","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The 'TemplateID' or 'Alias' value for the Template you wish to retrieve.","in":"path","name":"templateIdOrAlias","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDetailResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a Template","tags":["Templates API"]},"put":{"operationId":"updateTemplate","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The 'TemplateID' or 'Alias' value for the Template you wish to update.","in":"path","name":"templateIdOrAlias","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditTemplateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateRecordResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a Template","tags":["Templates API"]}},"/triggers/inboundrules":{"get":{"operationId":"listInboundRules","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"Number of records to return per request.","in":"query","name":"count","required":true,"schema":{"type":"integer"}},{"description":"Number of records to skip.","in":"query","name":"offset","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"InboundRules":{"items":{"properties":{"ID":{"type":"integer"},"Rule":{"format":"email","type":"string"}}},"type":"array"},"TotalCount":{"type":"integer"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"List inbound rule triggers","tags":["Inbound Rules API"]},"post":{"operationId":"createInboundRule","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboundRuleRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"ID":{"type":"integer"},"Rule":{"type":"string"}}}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create an inbound rule trigger","tags":["Inbound Rules API"]}},"/triggers/inboundrules/{triggerid}":{"delete":{"operationId":"deleteInboundRule","parameters":[{"description":"The token associated with the Server on which this request will operate.","in":"header","name":"X-Postmark-Server-Token","required":true,"schema":{"type":"string"}},{"description":"The ID of the Inbound Rule that should be deleted.","in":"path","name":"triggerid","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardPostmarkResponse"}}}},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a single trigger","tags":["Inbound Rules API"]}}},"servers":[{"url":"//api.postmarkapp.com"}],"components":{"responses":{"422":{"description":"An error was generated due to incorrect use of the API. See the Message associated with this response for more information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardPostmarkResponse"}}}},"500":{"description":"Indicates an internal server error occurred."}},"schemas":{"Attachment":{"description":"An attachment for an email message.","properties":{"Content":{"type":"string"},"ContentID":{"type":"string"},"ContentType":{"type":"string"},"Name":{"type":"string"}}},"AttachmentCollection":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array"},"BounceActivationResponse":{"properties":{"Bounce":{"$ref":"#/components/schemas/BounceInfoResponse"},"Message":{"type":"string"}}},"BounceCountElement":{"properties":{"Count":{"type":"integer"},"Name":{"type":"string"},"Type":{"type":"string"}}},"BounceDumpResponse":{"properties":{"Body":{"description":"Raw source of bounce. If no dump is available this will return an empty string.","type":"string"}}},"BounceInfoResponse":{"properties":{"BouncedAt":{"format":"date-time","type":"string"},"CanActivate":{"type":"boolean"},"Content":{"type":"string"},"Description":{"type":"string"},"Details":{"type":"string"},"DumpAvailable":{"type":"boolean"},"Email":{"format":"email","type":"string"},"ID":{"type":"string"},"Inactive":{"type":"boolean"},"MessageID":{"type":"string"},"Name":{"type":"string"},"Subject":{"type":"string"},"Tag":{"type":"string"},"Type":{"type":"string"},"TypeCode":{"type":"integer"}}},"BounceSearchResponse":{"description":"","properties":{"Bounces":{"items":{"$ref":"#/components/schemas/BounceInfoResponse"},"type":"array"},"TotalCount":{"type":"integer"}}},"CreateInboundRuleRequest":{"description":"","properties":{"Rule":{"format":"email","type":"string"}}},"CreateTemplateRequest":{"description":"The contents required for creating a new template.","properties":{"Alias":{"description":"The optional string identifier for referring to this Template (numbers, letters, and '.', '-', '_' characters, starts with a letter).","type":"string"},"HtmlBody":{"description":"The HTML template definition for this Template.","type":"string"},"Name":{"description":"The friendly display name for the template.","type":"string"},"Subject":{"description":"The Subject template definition for this Template.","type":"string"},"TextBody":{"description":"The Text template definition for this Template.","type":"string"}},"required":["Name","Subject"]},"DeliveryStatsResponse":{"description":"","properties":{"Bounces":{"items":{"$ref":"#/components/schemas/BounceCountElement"},"type":"array"},"InactiveMails":{"type":"integer"}}},"DynamicResponse":{"description":"The properties of this object will vary based request parameters."},"EditServerConfigurationRequest":{"properties":{"BounceHookUrl":{"type":"string"},"ClickHookUrl":{"description":"Webhook url allowing real-time notification when tracked links are clicked.","type":"string"},"Color":{"enum":["purple","blue","turqoise","green","red","yellow","grey"],"type":"string"},"DeliveryHookUrl":{"type":"string"},"InboundDomain":{"type":"string"},"InboundHookUrl":{"type":"string"},"InboundSpamThreshold":{"type":"integer"},"Name":{"type":"string"},"OpenHookUrl":{"type":"string"},"PostFirstOpenOnly":{"type":"boolean"},"RawEmailEnabled":{"type":"boolean"},"SmtpApiActivated":{"type":"boolean"},"TrackLinks":{"enum":["None","HtmlAndText","HtmlOnly","TextOnly"],"type":"string"},"TrackOpens":{"type":"boolean"}}},"EditTemplateRequest":{"description":"The contents required for creating a new template.","properties":{"Alias":{"description":"The optional string identifier for referring to this Template (numbers, letters, and '.', '-', '_' characters, starts with a letter).","type":"string"},"HtmlBody":{"description":"The HTML template definition for this Template.","type":"string"},"Name":{"description":"The friendly display name for the template.","type":"string"},"Subject":{"description":"The Subject template definition for this Template.","type":"string"},"TextBody":{"description":"The Text template definition for this Template.","type":"string"}},"required":["TemplateId"]},"EmailNameAddressPair":{"description":"","properties":{"Email":{"type":"string"},"Name":{"type":"string"}}},"EmailWithTemplateRequest":{"properties":{"Attachments":{"$ref":"#/components/schemas/AttachmentCollection"},"Bcc":{"format":"email","type":"string"},"Cc":{"format":"email","type":"string"},"From":{"format":"email","type":"string"},"Headers":{"$ref":"#/components/schemas/HeaderCollection"},"InlineCss":{"default":true,"type":"boolean"},"ReplyTo":{"type":"string"},"Tag":{"type":"string"},"TemplateAlias":{"description":"Required if 'TemplateId' is not specified.","type":"string"},"TemplateId":{"description":"Required if 'TemplateAlias' is not specified.","type":"integer"},"TemplateModel":{"type":"object"},"To":{"format":"email","type":"string"},"TrackLinks":{"description":"Replace links in content to enable \"click tracking\" stats. Default is 'null', which uses the server's LinkTracking setting'.","enum":["None","HtmlAndText","HtmlOnly","TextOnly"],"type":"string"},"TrackOpens":{"description":"Activate open tracking for this email.","type":"boolean"}},"required":["TemplateId","TemplateAlias","TemplateModel","To","From"]},"ExtendedMessageClickEventInformation":{"description":"","properties":{"ClickLocation":{"type":"string"},"Client":{"description":"","properties":{"Company":{"type":"string"},"Family":{"type":"string"},"Name":{"type":"string"}}},"Geo":{"properties":{"City":{"type":"string"},"Coords":{"type":"string"},"Country":{"type":"string"},"CountryISOCode":{"type":"string"},"IP":{"type":"string"},"Region":{"type":"string"},"RegionISOCode":{"type":"string"},"Zip":{"type":"string"}}},"MessageID":{"type":"string"},"OS":{"properties":{"Company":{"type":"string"},"Family":{"type":"string"},"Name":{"type":"string"}}},"OriginalLink":{"type":"string"},"Platform":{"type":"string"},"ReceivedAt":{"format":"date-time","type":"string"},"Recipient":{"format":"email","type":"string"},"Tag":{"type":"string"},"UserAgent":{"type":"string"}}},"ExtendedMessageOpenEventInformation":{"description":"","properties":{"Client":{"description":"","properties":{"Company":{"type":"string"},"Family":{"type":"string"},"Name":{"type":"string"}}},"FirstOpen":{"type":"boolean"},"Geo":{"properties":{"City":{"type":"string"},"Coords":{"type":"string"},"Country":{"type":"string"},"CountryISOCode":{"type":"string"},"IP":{"type":"string"},"Region":{"type":"string"},"RegionISOCode":{"type":"string"},"Zip":{"type":"string"}}},"MessageID":{"type":"string"},"OS":{"properties":{"Company":{"type":"string"},"Family":{"type":"string"},"Name":{"type":"string"}}},"Platform":{"type":"string"},"ReceivedAt":{"format":"date-time","type":"string"},"Recipient":{"format":"email","type":"string"},"Tag":{"type":"string"},"UserAgent":{"type":"string"}}},"HeaderCollection":{"items":{"$ref":"#/components/schemas/MessageHeader"},"type":"array"},"InboundMessageDetail":{"description":"","properties":{"Attachments":{"$ref":"#/components/schemas/Att