v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Messages

Send message

Send a message to a customer through one of the configured communication channels (email, SMS, or push notification).

⚠️ Action methods are available only in the Enterprise interface.

Before sending, the customer's communication consents for the target channel are checked; if consent is missing, the message is not sent. The message is rendered from its template, with personalisation applied if configured.

What happens when a message is sent

  • The rendered message is delivered to the customer through the configured channel.
  • A message record is persisted on the customer account; the retention period is project-specific.

Related operations

post/messages/actions/send-message

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

Example request

{
  "message": {
    "message_id": "8fd73167342d06899c4c015320",
    "status": 1,
    "message_template_id": "8bed991c68a470e7aaeffbf048",
    "customer_id": "8ea2591121e636086a4a9c0992",
    "contact": "happy_customer@crmcarecloud.com",
    "title": "Newsletter no. 30",
    "send_time": "2015-01-05 11:24:12",
    "opened_time": "2015-01-05 13:24:12",
    "mail_client_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.11.0",
    "mail_client_language": "cs,sk;q=0.8,en-US;q=0.5,en;q=0.3",
    "communication_channel_id": 1,
    "attachments": [
      {
        "upload_method": "url",
        "file_data": "https://upload.wikimedia.org/wikipedia/commons/c/ca/1x1.png",
        "cache_for": 20
      }
    ],
    "last_change": "2015-01-05 11:24:12"
  }
}

Response

No Content