Skip to main content
POST
/
v1
/
messages
Send a message
curl --request POST \
  --url https://api.distranmail.com/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "thread_id": "123e4567-e89b-12d3-a456-426614174000",
  "inbox_id": "123e4567-e89b-12d3-a456-426614174001",
  "recipients": [
    {
      "raw_address": "[email protected]",
      "type": "RECIPIENT_TYPE_TO"
    }
  ],
  "content_blocks": [
    {
      "type": "CONTENT_TYPE_HTML",
      "content": "<p>Hello World!</p>",
      "sequence": 1
    }
  ],
  "subject": "Important Update"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "direction": "MESSAGE_DIRECTION_UNSPECIFIED",
  "status": "MESSAGE_STATUS_UNSPECIFIED",
  "created_at": "2023-11-07T05:31:56Z",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject": "<string>",
  "sender": {
    "contact_id": "<string>",
    "contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "display_name": "<string>",
      "company": "<string>",
      "title": "<string>",
      "emails": [
        {
          "id": "<string>",
          "type": "EMAIL_TYPE_UNSPECIFIED",
          "email": "<string>"
        }
      ],
      "phones": [
        {
          "id": "<string>",
          "type": "PHONE_TYPE_UNSPECIFIED",
          "phone": "<string>"
        }
      ],
      "social_profiles": [
        {
          "id": "<string>",
          "type": "SOCIAL_PROFILE_TYPE_UNSPECIFIED",
          "username": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "last_contacted_at": "2023-11-07T05:31:56Z"
    },
    "raw_address": "<string>"
  },
  "recipients": [
    {
      "contact_id": "<string>",
      "raw_address": "<string>",
      "type": "RECIPIENT_TYPE_UNSPECIFIED"
    }
  ],
  "content_blocks": [
    {
      "type": "CONTENT_TYPE_UNSPECIFIED",
      "content": "<string>",
      "sequence": 2,
      "mime_type": "application/pdf",
      "filename": "<string>",
      "size": 123,
      "metadata": {}
    }
  ],
  "metadata": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "received_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
thread_id
string<uuid>
required

ID of the thread this message belongs to

​
inbox_id
string<uuid>
required

ID of the inbox to send the message through

​
recipients
object[]
required

List of message recipients

Minimum array length: 1
​
content_blocks
object[]
required

Message content blocks (text, HTML, attachments)

Minimum array length: 1
​
parent_id
string<uuid>

Optional ID of the parent message (for replies)

​
subject
string

Email subject line

Maximum string length: 998
​
metadata
object

Additional custom metadata for the message

Response

Message sent successfully

​
id
string<uuid>
required
​
thread_id
string<uuid>
required
​
inbox_id
string<uuid>
required
​
direction
enum<string>
required
Available options:
MESSAGE_DIRECTION_UNSPECIFIED,
MESSAGE_DIRECTION_INBOUND,
MESSAGE_DIRECTION_OUTBOUND
​
status
enum<string>
required
Available options:
MESSAGE_STATUS_UNSPECIFIED,
MESSAGE_STATUS_SENT,
MESSAGE_STATUS_FAILED,
MESSAGE_STATUS_QUEUED
​
created_at
string<date-time>
required
​
parent_id
string<uuid>
​
subject
string
Maximum string length: 998
​
sender
object
​
recipients
object[]
​
content_blocks
object[]
​
metadata
object
​
updated_at
string<date-time>
​
sent_at
string<date-time>
​
received_at
string<date-time>