Send an email

Sends a real email (or reply) from a connected email account. Provide either threadId (reply; takes precedence if both are given) or connectedAccountId (new email). cc and bcc are plain email strings, unlike to which uses the { identifier } object form. The connected account's enabled signature is appended automatically, and its email appearance is applied to plain-text and Markdown bodies. Explicit HTML remains caller-controlled. Set bodyFormat when the body is explicitly plain text, Markdown, or HTML. When delivering a saved draft, pass both draftMessageId and its opaque draftRevision so a newer edit cannot be consumed.

POST
/v1/messaging/send-email

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/messaging/send-email" \  -H "Content-Type: application/json" \  -d '{    "to": [      {        "identifier": "user@example.com"      }    ],    "subject": "string",    "body": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "messagingThreadId": "ea642f89-7688-4a10-9525-46b6c79cc287",
  "connectedAccountId": "ac03972a-5ca5-43c5-b96f-c519ac843b7a",
  "providerMessageId": "string",
  "provider": "google",
  "direction": "inbound",
  "sender": {
    "attendeeId": "string",
    "displayName": "string",
    "identifier": "string",
    "pictureUrl": "string",
    "profileUrl": "string",
    "headline": "string",
    "occupation": "string",
    "isSelf": true,
    "contact": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "firstName": "string",
      "lastName": "string",
      "avatarUrl": "string"
    }
  },
  "recipients": {
    "to": [],
    "cc": [],
    "bcc": []
  },
  "subject": "string",
  "bodyText": "string",
  "bodyHtml": "string",
  "attachmentsMeta": [
    {
      "id": "string",
      "name": "string",
      "fileName": "string",
      "type": "string",
      "mime": "string",
      "size": 9007199254740991,
      "sticker": true,
      "voiceNote": true,
      "gif": true,
      "durationSeconds": 0,
      "unavailable": true,
      "linkUrl": "string"
    }
  ],
  "isEvent": false,
  "isDeleted": false,
  "isHidden": false,
  "isDraft": false,
  "sentAt": "string",
  "editedAt": "string",
  "reactions": [],
  "draftRevision": "2019-08-24T14:15:22Z"
}
"string"
"string"
"string"
"string"