Send email message

org.intentschema.communication.email.message.send.v1

JSON: bare · @sha256:af62017a3278…
Hash: sha256:af62017a327850f5a868f6ec693574da27de861da84b08ba38e478b0159da3ab

Composes and sends an email message to one or more recipients.

Payload

FieldTypeDescription
target *Target
object *object
idempotency_keystring
object
FieldTypeDescription
fromstring (email)[]
to *string (email)[] (minItems 1)
ccstring (email)[]
bccstring (email)[]
subject *string
textBodystring
htmlBodystring
attachmentsBlobRef[]

Result

FieldTypeDescription
external_id *stringProvider message id.
thread_idstring
sent_at *string (date-time)

Examples

basic send to one recipient

{
  "target": {
    "system": "gmail"
  },
  "object": {
    "to": [
      "jane@example.com"
    ],
    "subject": "Checking in",
    "textBody": "Thursday still works for me."
  }
}

send with cc and an attachment

{
  "target": {
    "system": "gmail"
  },
  "object": {
    "to": [
      "\"Ops\" <ops@example.com>"
    ],
    "cc": [
      "cto@example.com"
    ],
    "subject": "Q3 review",
    "textBody": "Attached is the draft.",
    "attachments": [
      {
        "url": "https://files.example.com/q3.pdf",
        "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "filename": "q3.pdf",
        "mime_type": "application/pdf",
        "size": 1048576
      }
    ]
  },
  "idempotency_key": "01HN9X7K8J2Q3R4S5T6U7V8W9X"
}

Profiles