Skip to content
Home/
REST API Reference
/
/
Create Message Request Pa...

Create Message Request Payload

You can create a message

Any of:

You can create a message

message_typestring

The kind of message being created. Values: in_app, email or whatsapp.

Enum:"in_app""email""whatsapp"
Example:"in_app"
subjectstring

The title of the email.

Example:"Thanks for everything"
bodystring

The content of the message. HTML and plaintext are supported.

Example:"Hello there"
templatestring

The style of the outgoing message. Possible values plain or personal.

Example:"plain"
fromobject

The sender of the message. If not provided, the default sender will be used.

toRecipient (object) or Array of objects
One of:

A recipient of a message

ccRecipient (object) or Array of objects
One of:

A recipient of a message

bccRecipient (object) or Array of objects
One of:

A recipient of a message

created_atinteger

The time the message was created. If not provided, the current time will be used.

Example:1590000000
create_conversation_without_contact_replyboolean

Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided.

Default:false
Example:true
{
  "message_type": "in_app",
  "subject": "Thanks for everything",
  "body": "Hello there",
  "template": "plain",
  "from": {
    "type": "admin",
    "id": 394051
  },
  "to": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "cc": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "bcc": {
    "type": "user",
    "id": "536e564f316c83104c000020"
  },
  "created_at": 1590000000,
  "create_conversation_without_contact_reply": true
}