Create Conversational Message

curl --request POST \
  --url https://api.ahasend.com/v2/accounts/{account_id}/messages/conversation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": {
    "email": "noreply@example.com",
    "name": "Example Corp"
  },
  "to": [
    {
      "email": "user@example.com",
      "name": "John Doe"
    },
    {
      "email": "someone@example.com",
      "name": "Jane Doe"
    }
  ],
  "cc": [
    {
      "email": "hr@example.com",
      "name": "Example Corp HR"
    }
  ],
  "bcc": [
    {
      "email": "bcc@example.com",
      "name": "BCC Recipient"
    }
  ],
  "subject": "Welcome to Example Corp",
  "html_content": "<h1>Dear John and Jane, welcome to Example Corp!</h1>",
  "text_content": "Dear John and Jane, welcome to Example Corp!"
}
'

{
  "data": [
    {
      "recipient": {
        "email": "user@example.com",
        "name": "John Doe",
        "substitutions": {
          "first_name": "John",
          "order_id": "12345"
        }
      },
      "id": "<uuid@example.com>",
      "error": "<string>",
      "schedule": {
        "first_attempt": "2023-11-07T05:31:56Z",
        "expires": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Messages

Create Conversational Message

Creates and sends a conversational message (with support for CC and BCC) to one or more recipients. This API does not support template substitutions, use Create Message instead if you need substitutions.

Validation Requirements:

Either text_content or html_content is required
from.email must be from a domain you own with valid DNS records
retention.metadata must be between 1 and 30 days
retention.data must be between 0 and 30 days
If the reply_to parameter is provided, do not include reply-to in headers
If the cc parameter is provided, do not include cc in headers
message-id header will be ignored and automatically generated
Schedule times must be in RFC3339 format
schedule.first_attempt must be in the future and within 7 days of the request
schedule.expires must be in the future and within 8 days of the request

POST

accounts

{account_id}

messages

conversation

Create Conversational Message

curl --request POST \
  --url https://api.ahasend.com/v2/accounts/{account_id}/messages/conversation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": {
    "email": "noreply@example.com",
    "name": "Example Corp"
  },
  "to": [
    {
      "email": "user@example.com",
      "name": "John Doe"
    },
    {
      "email": "someone@example.com",
      "name": "Jane Doe"
    }
  ],
  "cc": [
    {
      "email": "hr@example.com",
      "name": "Example Corp HR"
    }
  ],
  "bcc": [
    {
      "email": "bcc@example.com",
      "name": "BCC Recipient"
    }
  ],
  "subject": "Welcome to Example Corp",
  "html_content": "<h1>Dear John and Jane, welcome to Example Corp!</h1>",
  "text_content": "Dear John and Jane, welcome to Example Corp!"
}
'

{
  "data": [
    {
      "recipient": {
        "email": "user@example.com",
        "name": "John Doe",
        "substitutions": {
          "first_name": "John",
          "order_id": "12345"
        }
      },
      "id": "<uuid@example.com>",
      "error": "<string>",
      "schedule": {
        "first_attempt": "2023-11-07T05:31:56Z",
        "expires": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

API key for authentication

Headers

Idempotency-Key

string

Optional idempotency key for safe request retries. Must be a unique string for each logical request. Requests with the same key will return the same response. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

account_id

string<uuid>

required

Account ID

Body

application/json

from

object

required

Show child attributes

Example:

{
  "email": "noreply@example.com",
  "name": "Example Corp"
}

object[]

required

This parameter can set the To header to multiple addresses. The combined to, cc, and bcc recipient count must not exceed 50.

Required array length: 1 - 50 elements

Show child attributes

subject

string

required

Email subject line

object[]

This parameter can set the CC header to multiple addresses. Do not include cc in the headers array. The combined to, cc, and bcc recipient count must not exceed 50.

Required array length: 1 - 50 elements

Show child attributes

bcc

object[]

This parameter can set the To header to multiple addresses. The combined to, cc, and bcc recipient count must not exceed 50.

Required array length: 1 - 50 elements

Show child attributes

reply_to

object

If provided, the reply-to header in headers array must not be provided

Show child attributes

Example:

{
  "email": "noreply@example.com",
  "name": "Example Corp"
}

text_content

string

Plain text content. Required if html_content is empty

html_content

string

HTML content. Required if text_content is empty

amp_content

string

AMP HTML content

attachments

object[]

File attachments

Show child attributes

headers

object

Custom email headers. cc and reply-to headers cannot be provided if reply_to or cc parameters are provided, message-id will be ignored and automatically generated

Show child attributes

Response

Message created successfully

object

enum<string>

required

Object type identifier

Available options:

list

data

object[]

required

List of messages and their statuses

Show child attributes

Create Message Get Message