Email Collection

Description

A collection (or list) of resources.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
body

The message to include in the body of the email.

recipientEmails

Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas.

subject

The subject line for the email message.

type

The type of resource represented.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The type of resource represented.

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"
}