Email Collection

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A basic email message.",
        "properties": {
          "body": {
            "description": "The message to include in the body of the email.",
            "maxLength": 10000,
            "type": "string"
          },
          "recipientEmails": {
            "description": "Email address(es) to send the email to. If provided, must be an\narray of valid email addresses. Optional, but may be required by\nchild schemas.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "subject": {
            "description": "The subject line for the email message.",
            "maxLength": 200,
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "enum": [
                  "email"
                ]
              },
              {
                "$ref": "#/components/schemas/Type"
              }
            ]
          }
        },
        "required": [
          "type",
          "subject",
          "body"
        ],
        "type": "object"
      },
      "title": "Email Message",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "email-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection of Email Messages",
  "type": "object"
}