Skip to main content
Send Message
curl --request POST \
  --url https://integration.getmateo.com/api/v1/send_message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_status": "open",
  "to": [
    {
      "handle": "<string>",
      "country_codes": [
        "<string>"
      ],
      "full_name": "<string>",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_contact_id": "<string>",
      "secondary_external_contact_id": "<string>"
    }
  ],
  "cc": [
    {
      "handle": "<string>",
      "country_codes": [
        "<string>"
      ],
      "full_name": "<string>",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_contact_id": "<string>",
      "secondary_external_contact_id": "<string>"
    }
  ],
  "bcc": [
    {
      "handle": "<string>",
      "country_codes": [
        "<string>"
      ],
      "full_name": "<string>",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_contact_id": "<string>",
      "secondary_external_contact_id": "<string>"
    }
  ],
  "subject": "<string>",
  "html": "<string>",
  "text": "<string>",
  "content": {},
  "send_after": "2023-11-07T05:31:56Z",
  "placeholder_values": [
    "<string>"
  ],
  "reply_to_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attachments": [
    "<string>"
  ],
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "review_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "actions": [
    {
      "text": "<string>",
      "type": "quick_reply",
      "data": "<string>",
      "subtype": "url"
    }
  ]
}
'
{
  "conversation": {
    "id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "organisation_id": "<string>",
    "subject": "<string>",
    "assignee_id": "<string>",
    "unread": true,
    "channel_id": "<string>",
    "contact_id": "<string>",
    "external_id": "<string>",
    "is_spam": true,
    "inbox_id": "<string>",
    "latest_message_id": "<string>",
    "latest_inbound_message_id": "<string>",
    "latest_message_created_at": "<string>",
    "latest_inbound_message_created_at": "<string>",
    "tags": [
      "<string>"
    ],
    "files": [
      {}
    ],
    "channel_type": "email",
    "status": "open"
  },
  "message": {
    "id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "organisation_id": "<string>",
    "conversation_id": "<string>",
    "is_inbound": true,
    "subject": "<string>",
    "blurb": "<string>",
    "author_id": "<string>",
    "content": {},
    "raw_content": "<string>",
    "status": "sent",
    "attachment_count": 123,
    "reply_to_message_id": "<string>",
    "external_files": {},
    "external_id": "<string>",
    "template_id": "<string>",
    "review_channel_id": "<string>",
    "author_type": "employee",
    "forwarded": true,
    "forwarded_message_text": "<string>",
    "send_after": "<string>",
    "footer": "<string>",
    "sendout_id": "<string>",
    "campaign_id": "<string>",
    "sent_at": "<string>",
    "timestamp": "<string>",
    "location": {},
    "location_metadata": {},
    "contacts": {},
    "files": {},
    "header_media_filename": "<string>"
  },
  "recipients": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "organisation_id": "<string>",
      "conversation_id": "<string>",
      "message_id": "<string>",
      "contact_id": "<string>",
      "handle": "<string>",
      "full_name": "<string>",
      "is_organisation": true,
      "role": "from",
      "status": "sent"
    }
  ],
  "actions": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "organisation_id": "<string>",
      "conversation_id": "<string>",
      "message_id": "<string>",
      "text": "<string>",
      "data": "<string>",
      "clicked": true,
      "type": "quick_reply",
      "subtype": "url"
    }
  ]
}

​
Postal Messages

When sending a postal message, the recipient must contain the contact_id and no handle. If the contact does not exist yet, make sure to create it first.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
from
string<uuid>
required

Channel ID from which the message will be sent

​
id
string<uuid> | null

Message ID

​
conversation_id
string<uuid> | null

Conversation ID

​
conversation_status
enum<string> | null

Conversation Status

Available options:
open,
closed,
archived
​
to
object[] | null

To Recipients of the message

​
cc
object[] | null

CC Recipients of the message

​
bcc
object[] | null

BCC Recipients of the message

​
subject
string | null

Subject of the message

​
html
string | null

HTML content of the message

​
text
string | null

Text content of the message

​
content
object

Content of the message. Only use this if you know what you are doing. Prefer using html or text otherwise

​
send_after
string<date-time> | null

Send the message after this time

​
placeholder_values
string[] | null

Placeholder values for the message

​
reply_to_message_id
string<uuid> | null

Message ID to which this message is a reply

​
attachments
string[] | null

Attachment URLs to the message. Can either https:// or media_library://

​
template_id
string<uuid> | null

Template ID

​
review_channel_id
string<uuid> | null

Review Channel ID

​
marketing_channel_id
string<uuid> | null

Marketing Channel ID

​
actions
object[] | null

Actions for the message, e.g. quick reply buttons

Response

The message was sent successfully

​
conversation
object
required
​
message
object
required
​
recipients
object[]
required
​
actions
object[]
required