Calculate Price

POST

/email-campaigns/price

Email Marketing

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/email-campaigns/price' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": "<p>This is a test</p>",
    "from_email_address_id": 2,
    "from_name": "From name",
    "list_id": 456,
    "name": "John Doe",
    "subject": "Lorem Ipsum",
    "template_id": 31
}'

Response Example

{
    "data": {
        "currency": {
            "currency_name_long": "Australian Dollars",
            "currency_name_short": "AUD",
            "currency_prefix_c": "c",
            "currency_prefix_d": "$"
        },
        "data": {
            "body": "<p>This is a test</p>",
            "from_email_address_id": 2,
            "from_name": "From name",
            "list_id": 456,
            "name": "John Doe",
            "subject": "Lorem Ipsum",
            "template_id": 31
        },
        "queued_count": 2,
        "total_count": 6,
        "total_price": "0.0066"
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Total price for email campaign."
}

Request

Body Params application/json

from_email_address_id

number

required

The allowed email address id.

from_name

string

required

The name that will appear on the email.

list_id

number

required

The list id you want to access.

name

string

required

The name of the sender.

schedule

number

optional

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

subject

string

required

The subject of the email campaign.

template_id

number

required

The template id you want to use.

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get All Email Campaigns

Create Email Campaign