Messages

Send outbound email message

Manually start a new outbound email conversation from a configured email campaign.

Conflict handling:

  • If an active email conversation already exists with the same recipient, returns 409 ACTIVE_CONVERSATION_EXISTS with conflictData.existingConversationId. Re-send with force: true to append to that conversation.

Template resolution:

  • If templateId is omitted, the agent's pre-configured template is used.
  • variables are passed as { variableName: "value" } — no CSV field mapping required.
post/api/v1/messages/outbound/email

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/messages/outbound/email
  • Auth: bearerAuth (a scheme the document does not define)

Request body

campaignIdstring uuid required

UUID of an active email outbound campaign

tostring email required

Recipient email address

templateIdstring uuid

Override agent's default email template UUID

variablesobject

Direct template variable values: { firstName: 'Marco' }

forceboolean

Skip active-conversation conflict check after user confirms

Example request

{
  "campaignId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "to": "recipient@example.com",
  "variables": {
    "firstName": "Marco",
    "company": "HolaCasa"
  }
}

Response

Created

successtrue required
messagestring

Changes

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