Email Send

POST

/email/send

Transactional Email

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/email/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "attachments": [
        {
            "content": "ZmlsZSBjb250ZW50cw==",
            "content_id": "text",
            "disposition": "attachment",
            "filename": "text.txt",
            "type": "text/plain"
        }
    ],
    "bcc": [
        {
            "email": "test3@clicksend.com",
            "name": "Joseph Doe"
        }
    ],
    "body": "Lorem ipsum",
    "cc": [
        {
            "email": "test2@clicksend.com",
            "name": "Jane Doe"
        }
    ],
    "from": {
        "email_address_id": 1,
        "name": "Joanne Doe"
    },
    "subject": "Test subject",
    "to": [
        {
            "email": "test@clicksend.com",
            "name": "John Doe"
        }
    ]
}'

Response Example

{
    "data": {
        "_attachments": [
            {
                "_attachment_file_url": "https://rest.clicksend.com/files/3C2284DC-7C37-47BA-8C95-3F12A4B987B7.txt",
                "content_disposition": "attachment",
                "content_id": "text",
                "content_type": "text/plain",
                "file_name": "text.txt"
            }
        ],
        "_currency": {
            "currency_name_long": "British Pounds",
            "currency_name_short": "GBP",
            "currency_prefix_c": "p",
            "currency_prefix_d": "£"
        },
        "bcc": [
            {
                "email": "test3@clicksend.com",
                "name": "Joseph Doe"
            }
        ],
        "body": "Lorem ipsum",
        "body_plain_text": "Lorem ipsum",
        "cc": [
            {
                "email": "test2@clicksend.com",
                "name": "Jane Doe"
            }
        ],
        "custom_string": null,
        "date_added": 1507018182,
        "from_email_address_id": 1,
        "from_name": "Joanne Doe",
        "hard_bounce_count": 0,
        "message_id": "21C632C1-3FCC-4EFF-8191-6079244F0142",
        "price": "0.0050",
        "schedule": 1507018182,
        "soft_bounce_count": 0,
        "status": "WaitApproval",
        "status_text": "Accepted for delivery",
        "subaccount_id": 1,
        "subject": "Test subject",
        "to": [
            {
                "email": "test@clicksend.com",
                "name": "John Doe"
            }
        ],
        "user_id": 1
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Transactional email queued for delivery."
}

Request

Body Params application/json

attachments

array

optional

The attachments of the email.

bcc

array

optional

The bcc of the email. Follows the same structure as to.

body

string

required

The content of the email.

array

optional

The cc of the email. Follows the same structure as to.

from.email_address_id

number

required

The sender's email address ID.

from.name

string

optional

The sender's name.

schedule

number

optional

Leave blank for immediate delivery. Your schedule time as a unix timestamp.

array

required

The recipients of the email.

Examples

Responses

🟢200OK

application/json

Body

object {0}

Add a Test Delivery Receipt

Export Fax History