Compose Message

Compose a draft outbound comms message (email/SMS) without sending. Distinct from mailbox DRAFT_MESSAGE.

POST/api/v1/comms/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/comms/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: COMPOSE_MESSAGE" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "string",
    "channel": "EMAIL",
    "recipient_address": "string",
    "recipient_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "sender_type": "USER",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "tone": "FORMAL"
  }'

Authorization

Minimum role: Sales repThe caller must hold this role or a higher one.
Action: COMPOSE_MESSAGE

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be COMPOSE_MESSAGE for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

bodystringRequired
No description yet.
minimum length 1
channelenumRequired
No description yet.
Allowed values
- EMAIL
- SLACK
- WHATSAPP
- TEAMS
- VOICE
- VIDEO_MEETING
- SMS
- LINKEDIN
- CHAT
- WEBHOOK
recipient_addressstringRequired
Resolved delivery address (the UI recipient picker supplies it). NOT NULL in comms_messages and required by the outbox worker to send.
minimum length 1
recipient_iduuidRequired
No description yet.
sender_typeenumRequired
No description yet.
Allowed values
- USER
- LEAD
- CONTACT
- AGENT
tenant_iduuidRequired
No description yet.
toneenumRequired
No description yet.
Allowed values
- FORMAL
- CASUAL
- URGENT
- CONSULTATIVE
subjectstring or nullOptional
No description yet.

Response

Status 202. The command was applied. The body is the record as it stands after the command: a JSON object whose fields depend on the record.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send COMPOSE_MESSAGE.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below rep or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.