Send an email
Sends an outbound email scoped to your company. Two usage patterns:
From an existing draft — provide discussionId and uuid returned by
POST /api/email/create-draft. The draft’s stored recipients, subject, and body are
used.
On-the-fly — omit discussionId and uuid and provide userId, channelId,
recipients, subject, and body. A draft is created automatically before sending.
Documentation Index
Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Body
Stream ID from POST /api/email/create-draft. Required if uuid is set.
Draft UUID from POST /api/email/create-draft. Required if discussionId is set.
If true (default), the send fails when the email would create a new
discussion thread rather than reply to an existing one.
Required when sending on-the-fly (no discussionId/uuid).
Required when sending on-the-fly.
Response
Email sent successfully.
The response is of type object.