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": "john.doe@distranmail.com",
      "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",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "direction": "MESSAGE_DIRECTION_UNSPECIFIED",
  "status": "MESSAGE_STATUS_UNSPECIFIED",
  "subject": "<string>",
  "sender": {
    "contact_id": "<string>",
    "contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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": {},
      "created_at": "2023-11-07T05:31:56Z",
      "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": {},
  "created_at": "2023-11-07T05:31:56Z",
  "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

Response

201
application/json

Message sent successfully

The response is of type object.