Events

Send an email about an event

Queues an email through a connected Gmail / Outlook mailbox, like the app's composer: the mailbox signature is added, the message joins the event's conversation, and the worker sends it once send_after is past (30 seconds, during which it can be cancelled from the event's emails tab; a failed send can be retried there). The mailbox must be the caller's own or a sending mailbox shared with the workspace, active and allowed to send; it defaults to the caller's primary events mailbox. Limited to 20 emails per minute per workspace (shared with MCP). Role permission: data.write.

post/events/{id}/emails

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/events/{id}/emails
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.write)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Request body

tostring[] required
ccstring[]
bccstring[]
subjectstring required
bodystring required

HTML or plain text.

connection_idstring uuid

Mailbox connection to send from. Defaults to the caller's primary active events connection in this workspace.

template_idstring uuid

Email template the message was written from (recorded with it).

Response

Email queued.

successboolean
messagestring
status'queued'
outbox_idstring uuid
connection_idstring uuid
send_afterstring date-time

Example response

{
  "success": true,
  "message": "Email queued for jane@acme.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.