Invoice Email

OpenAPI Schema

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

{
  "description": "An email message to a client about their invoice.",
  "properties": {
    "body": {
      "description": "The message to include in the body of the email.",
      "maxLength": 10000,
      "type": "string"
    },
    "buttonText": {
      "description": "The text for the call-to-action button in the email body.",
      "maxLength": 25,
      "type": "string"
    },
    "emailTemplateId": {
      "description": "The identifier for the email template chosen (if applicable).",
      "type": "integer"
    },
    "headline": {
      "description": "The headline to use in the email body.",
      "maxLength": 100,
      "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"
  ],
  "title": "Studio-to-Client Email Message",
  "type": "object"
}