POST/v1/sent-emailsemails:send

Send an email

Enqueues a Gmail send via the operator's connected mailbox. Returns immediately with `status: "queued"`. The Gmail handler stamps `status` to `sent` once the send completes (typically <2s).

Run a request

POST/v1/sent-emails

Base URL

Request body (JSON)

Resolved URL

POSThttps://coldos.justgotwyrd.com/api/v1/sent-emails

Paste an API key in the bar at the top of the page to enable Execute.

Parameters

Body parameters

contact_iduuidrequired
Contact to email.
subjectstringrequired
Subject. `{{tokens}}` are resolved server-side.
bodystringrequired
HTML body. Plain-text alternative is auto-derived.
from_emailstringoptional
Connected Gmail address. Defaults to the API key's primary mailbox.
ccstring[]optional
Cc recipients. Empty array = no Cc.
bccstring[]optional
Bcc recipients.
track_opensbooleanoptionaldefault true
Inject the open-tracking pixel.
track_clicksbooleanoptionaldefault false
Rewrite links through the click-redirect.
include_unsubscribebooleanoptionaldefault true
Add the RFC 8058 List-Unsubscribe headers.
reply_to_sent_email_idstringoptional
If set, reply-on-thread instead of starting a new thread.

Responses

400Invalid request — see `error.message`.
401Missing or invalid API key.
403Authenticated, but the key lacks the required scope.
404The referenced resource does not exist or is not visible to your key.
429Rate limit exceeded — see `Retry-After`.
500Unexpected server error. Safe to retry with idempotency-key.

Code samples

curl -X POST "https://coldos.justgotwyrd.com/api/v1/sent-emails" \
  -H "Authorization: Bearer $COLD_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "contact_id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
      "subject": "Quick question about {{company_name}}",
      "body": "<p>Hi {{first_name}},</p><p>Quick question about Acme's APAC pipeline...</p>",
      "track_opens": true
    }'

Response · 200

{
  "id": "01HZS3RV6W7X8Y9Z0A1B2C3D4E",
  "contact_id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
  "thread_id": "thread_F8K2J3D9",
  "from_email": "polymath@justgotwyrd.com",
  "to_email": "ankit@example.com",
  "cc": [],
  "bcc": [],
  "subject": "Quick question about Acme's APAC pipeline",
  "rfc_message_id": "<CAFv-...@mail.gmail.com>",
  "rendered_subject": "Quick question about Acme's APAC pipeline",
  "status": "queued",
  "sent_at": "2026-05-01T09:02:14.000+05:30"
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.