Basic Email Message

Description

A basic email message.

Properties

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.

OpenAPI Schema

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

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