/messages/email

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "/messages/email",
  "description": "Creates a new Email message.",
  "type": "object",
  "properties": {
    "subject": {
      "description": "Subject line of the email. Required if a template is not\nspecified. If a template is specified and subject is provided,\nthen the provided subject will be used instead of the\ntemplate's subject.\n",
      "type": "string",
      "example": "Today's Weather"
    },
    "body": {
      "description": "Body of the email. Required if a template is not specified. If\na template is specified and body is provided, then the provided\nbody will be used instead of the template's body.\n",
      "type": "string",
      "example": "Today is Sunny and 70F."
    },
    "recipients": {
      "description": "List of objects defining who will receive the email. Objects\nmust include an \"email\" attribute. Objects may include a\n\"macros\" attribute whose value is an object mapping macro names\nto values to be used.\n",
      "type": "string",
      "example": "[\n    {\n      \"email\": \"test01@test.govdelivery.com\",\n      \"macros\": {\n        \"city\": \"RECIPIENT Saint Paul\",\n        \"address\": \"RECIPIENT 408 Saint Peter Street\",\n        \"company\": \"RECIPIENT GovDelivery\",\n        \"url\": \"RECIPIENT www.govdelivery.com\"\n      }\n    },\n    {\n      \"email\": \"test02@test.govdelivery.com\",\n      \"macros\": {\n        \"city\": \"RECIPIENT Minneapolis\",\n        \"address\": \"RECIPIENT 1234 Main Street\",\n        \"company\": \"RECIPIENT Company Name\",\n        \"url\": \"RECIPIENT www.example.com\"\n      }\n    }\n]\n"
    },
    "from_name": {
      "description": "Display name of the sender. If a template is specified and a\nfrom_name is provided, then the provided from_name will be used\ninstead of the template's from_name.\n",
      "type": "string",
      "example": "Weather Bot"
    },
    "from_email": {
      "description": "Email address of the sender. Must be an email address authorized\nto send from your account.\n",
      "type": "string",
      "example": "weather@example.com"
    },
    "click_tracking_enabled": {
      "description": "Enable or disable click tracking for an email message. If a\ntemplate is provided, than the default value will be the\nvalue of that template's click_tracking_enabled attribute.\nOtherwise, defaults to true.\n",
      "type": "boolean"
    },
    "open_tracking_enabled": {
      "description": "Enable or disable open tracking for an email message. If a\ntemplate is provided, then the default value will be the\nvalue of that template's open_tracking_enabled attribute.\nOtherwise, defaults to true.\n",
      "type": "boolean"
    },
    "message_type_code": {
      "description": "The unique identifier of the Message Type to associate\nwith this message. A Message Type will be created if it doesn't\nexist. The Message Type's label will be generated from this value,\nand can be updated via the Message Type resource.\n",
      "type": "string"
    },
    "macros": {
      "description": "List of macros valid for the message, including the default\nvalues that will be used if the macros are missing for any\nrecipients. If a template is provided, any macros and\ndefault values provided here will be merged with any macros\ndefined in the specifided template, with the default values\nprovided here overriding the default values defined by the\ntemplate.\n",
      "type": "string",
      "example": "{\n    \"city\": \"DEFAULT Saint Paul\",\n    \"address\": \"DEFAULT 408 Saint Peter Street\",\n    \"company\": \"DEFAULT GovDelivery\",\n    \"url\": \"DEFAULT www.govdelivery.com\"\n}\n"
    },
    "_links": {
      "description": "The links to be associated with this email message.\n\nPossible Parameters are:\n\n  - email_template:\n    - Required: No\n    - UUID of a template to use. For more information on\n      templates, see documentation for the\n      [/templates/email](/api/tms/resource/templates/email/)\n      endpoint.\n",
      "type": "string",
      "example": "{\n  \"email_template\": \"new_template-1\"\n}\n"
    }
  },
  "required": [
    "recipients"
  ]
}