PostRestEmailRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gatewayapi/main/json-schema/gatewayapi-post-rest-email-request-schema.json",
  "title": "PostRestEmailRequest",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/gatewayapi-openapi-generated.yml#/components/schemas/PostRestEmailRequest",
  "type": "object",
  "properties": {
    "html": {
      "type": "string",
      "description": "The html content of the email"
    },
    "plaintext": {
      "type": "string",
      "description": "The plain text content of the email"
    },
    "subject": {
      "type": "string",
      "description": "The subject line of the email, tags can be used like in the message to personalize the subject"
    },
    "from": {
      "type": "string",
      "description": "The name and email of the sender, can be just the email if no name is specified, see below for format"
    },
    "reply": {
      "type": "string",
      "description": "The name and email of the sender, can be just the email if no name is specified, see below for format"
    },
    "callback_url": {
      "type": "string",
      "description": "Callback URL to get status reports"
    },
    "userref": {
      "type": "string",
      "description": "Add your own custom reference to be passed back to the provided callback URL"
    },
    "tags": {
      "type": "array",
      "description": "A list of string tags, which will be replaced with the tag values for each recipient, if used remember to also add tagvalues to all recipients"
    },
    "recipients": {
      "type": "array",
      "description": "List of email addresses to receive the email"
    },
    "attachments": {
      "type": "array",
      "description": "A list of base64 encoded files to be attached to the email"
    }
  }
}