/bff/emailer/compose

Composes a new email with the given subject, message, and optional attachments, then sends it.

EmailerpostBffEmailerCompose

Parameters

JSON body

Request body

application/json

variantstringRequired

Sending variant (e.g. single, bulk).

Examplesingle

contactListstringOptional

Comma-separated list of contact IDs to send to.

segmentIdstringOptional

External ID of a contact segment to use as recipient list. Required when variant = "contactSegment".

subjectstringRequired

Email subject line.

messagestringRequired

Email body content (HTML or plain text).

attachmentTokensstring[]Optional

Optional list of blob tokens to attach to the e-mail. Blobs must belong to the same organisation as the request.

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

POST /bff/emailer/compose

post

curl -X POST "https://api.bizkithub.com/bff/emailer/compose" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "variant": "single",
  "contactList": "example_contactList",
  "segmentId": "example_segmentId",
  "subject": "example_subject",
  "message": "example_message",
  "attachmentTokens": [
    "string"
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key