object ServerConfigurationResponse

{
  "properties": {
    "ID": {
      "type": "integer"
    },
    "Name": {
      "type": "string"
    },
    "Color": {
      "enum": [
        "purple",
        "blue",
        "turqoise",
        "green",
        "red",
        "yellow",
        "grey"
      ],
      "type": "string"
    },
    "ApiTokens": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "ServerLink": {
      "type": "string"
    },
    "TrackLinks": {
      "enum": [
        "None",
        "HtmlAndText",
        "HtmlOnly",
        "TextOnly"
      ],
      "type": "string"
    },
    "TrackOpens": {
      "type": "boolean"
    },
    "InboundHash": {
      "type": "string"
    },
    "OpenHookUrl": {
      "type": "string"
    },
    "ClickHookUrl": {
      "type": "string"
    },
    "BounceHookUrl": {
      "type": "string"
    },
    "InboundDomain": {
      "type": "string"
    },
    "InboundAddress": {
      "type": "string",
      "format": "email"
    },
    "InboundHookUrl": {
      "type": "string"
    },
    "DeliveryHookUrl": {
      "type": "string"
    },
    "RawEmailEnabled": {
      "type": "boolean"
    },
    "SmtpApiActivated": {
      "type": "boolean"
    },
    "PostFirstOpenOnly": {
      "type": "boolean"
    },
    "InboundSpamThreshold": {
      "type": "integer"
    }
  }
}

object StandardPostmarkResponse

{
  "properties": {
    "Message": {
      "type": "string"
    },
    "ErrorCode": {
      "type": "integer"
    }
  },
  "description": "A Postmark API error."
}

object StatsApiGetBounceCountsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetBrowserPlatformUsageResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetEmailClientUsageResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetEmailOpenCountsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetEmailPlatformUsageResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetOutboundClickCountsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetOutboundClicksBrowserFamiliesResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetOutboundClicksLocationResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetSpamComplaintsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object StatsApiGetTrackedEmailCountsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object TemplateDetailResponse

{
  "properties": {
    "Name": {
      "type": "string",
      "description": "The display name for the template."
    },
    "Alias": {
      "type": "string",
      "description": "The user-supplied alias for this template."
    },
    "Active": {
      "type": "boolean",
      "description": "Indicates that this template may be used for sending email."
    },
    "Subject": {
      "type": "string",
      "description": "The content to use for the Subject when this template is used to send email."
    },
    "HtmlBody": {
      "type": "string",
      "description": "The content to use for the HtmlBody when this template is used to send email."
    },
    "TextBody": {
      "type": "string",
      "description": "The content to use for the TextBody when this template is used to send email."
    },
    "TemplateID": {
      "type": "integer",
      "description": "The ID associated with the template."
    },
    "AssociatedServerId": {
      "type": "integer",
      "description": "The ID of the Server with which this template is associated."
    }
  }
}

object TemplateListingResponse

{
  "properties": {
    "TotalCount": {
      "type": "number",
      "description": "The total number of Templates API associated with this server."
    },
    "Templates API": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateRecordResponse"
      },
      "description": "Basic information for each Template returned from the query."
    }
  }
}

object TemplateRecordResponse

{
  "properties": {
    "Name": {
      "type": "string",
      "description": "The display name for this template."
    },
    "Alias": {
      "type": "string",
      "description": "The user-supplied alias for this template."
    },
    "Active": {
      "type": "boolean",
      "description": "True if this template is currently available for use."
    },
    "TemplateId": {
      "type": "number",
      "format": "int",
      "description": "The associated ID for this template."
    }
  }
}

object TemplateValidationError

{
  "properties": {
    "Line": {
      "type": "integer"
    },
    "Message": {
      "type": "string"
    },
    "CharacterPosition": {
      "type": "integer"
    }
  }
}

object TemplateValidationRequest

{
  "properties": {
    "Subject": {
      "type": "string",
      "description": "The subject content to validate. Must be specified if HtmlBody or\nTextBody are not. See our template language documentation for more\ninformation on the syntax for this field.\n"
    },
    "HtmlBody": {
      "type": "string",
      "description": "The html body content to validate. Must be specified if Subject or\nTextBody are not. See our template language documentation for more\ninformation on the syntax for this field.\n"
    },
    "TextBody": {
      "type": "string",
      "description": "The text body content to validate. Must be specified if HtmlBody or\nSubject are not. See our template language documentation for more\ninformation on the syntax for this field.\n"
    },
    "TestRenderModel": {
      "type": "object",
      "description": "The model to be used when rendering test content."
    },
    "InlineCssForHtmlTestRender": {
      "type": "boolean",
      "default": true,
      "description": "When HtmlBody is specified, the test render will have style blocks\ninlined as style attributes on matching html elements. You may disable\nthe css inlining behavior by passing false for this parameter.\n"
    }
  }
}

object TemplateValidationResponse

{
  "properties": {
    "Subject": {
      "$ref": "#/components/schemas/TemplateValidationResult"
    },
    "HtmlBody": {
      "$ref": "#/components/schemas/TemplateValidationResult"
    },
    "TextBody": {
      "$ref": "#/components/schemas/TemplateValidationResult"
    },
    "AllContentIsValid": {
      "type": "boolean"
    },
    "SuggestedTemplateModel": {
      "type": "object"
    }
  }
}

object TemplateValidationResult

{
  "properties": {
    "ContentIsValid": {
      "type": "boolean"
    },
    "RenderedContent": {
      "type": "string"
    },
    "ValidationErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateValidationError"
      }
    }
  }
}

object TemplatesApiCreateTemplateResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object TemplatesApiDeleteTemplateResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object TemplatesApiGetTemplateByIdResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object TemplatesApiListTemplatesResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object TemplatesApiUpdateTemplateResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object TemplatesApiValidateTemplateContentResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}