Send Email
Email
Send Email
Send an email through the workspace’s connected Gmail or Office 365 account
POST
Send Email
Request
Headers
Optional client-generated key (UUIDv4 recommended). When present, the gateway deduplicates retries within a 24-hour window and returns the original response. Strongly recommended for all send operations so that network retries never produce duplicate messages.
Body Parameters
Recipient email address, or an array of addresses. RFC 5322 addresses are accepted (e.g.
"Jane Doe <jane@example.com>").Email subject line. Maximum 998 characters per RFC 2822, but 150 characters is strongly recommended for deliverability.
HTML-formatted message body. Either
body_html or body_text is required. When both are supplied, the email is sent as a multipart/alternative message and clients select the best representation.Plain-text message body. Either
body_html or body_text is required.Optional array of carbon-copy recipients.
Optional array of blind carbon-copy recipients.
Optional Reply-To address. Defaults to the sending mailbox when omitted.
Optional contact UUID. When supplied, the message is linked to the contact’s timeline automatically.
Optional deal UUID. When supplied, the message is logged against the deal.
Optional thread identifier to reply into an existing conversation. When omitted, a new thread is created.
Optional array of attachments. Each entry accepts
filename, mime_type, and either content_base64 or storage_path.Response
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID for support traceability.
Example Response
Errors
| Status | Code | Description |
|---|---|---|
| 400 | validation_error | Missing to, subject, or both body_html and body_text |
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing write:email permission, or no connected email provider |
| 409 | idempotency_conflict | Same Idempotency-Key reused with a different payload |
| 429 | rate_limited | Per-second or per-day send cap exceeded |
| 502 | provider_error | The upstream email provider (Gmail / Microsoft) returned an error |