Calculate Direct Mail Campaign Price

POST

/post/direct-mail/campaigns/price

Post Direct Mail

Calculate direct mail campaign price.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/post/direct-mail/campaigns/price' \
--header 'Content-Type: application/json' \
--data-raw '{
    "areas": [
        {
            "location_id": 22,
            "quantity": 12
        },
        {
            "location_id": 21,
            "quantity": 10
        },
        {
            "location_id": 21,
            "quantity": 10
        }
    ],
    "custom_string": "Custom String",
    "file_urls": [
        "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_front.pdf",
        "https://rest.clicksend.com/files/F3CA1167-381B-47FE-A146-3DF87BE7EEC2.pdf"
    ],
    "name": "My Campaign",
    "schedule": 1477384503,
    "size": "A5",
    "source": "My Source"
}'

Response Example

{
    "data": {
        "currency": {
            "currency_name_long": "British Pounds",
            "currency_name_short": "GBP",
            "currency_prefix_c": "p",
            "currency_prefix_d": "Â£"
        },
        "data": {
            "_areas": [
                {
                    "campaign_id": null,
                    "country_code": "AU",
                    "country_name": "Australia",
                    "location_id": 22,
                    "place_name": "AUSTRALIA",
                    "postal_code": "1234",
                    "price": 133.2,
                    "quantity": 12,
                    "status": "Queued"
                },
                {
                    "campaign_id": null,
                    "country_code": "GB",
                    "country_name": "United Kingdom",
                    "location_id": 21,
                    "place_name": "CANDELARIA",
                    "postal_code": "1234",
                    "price": 11.1,
                    "quantity": 10,
                    "status": "Queued"
                },
                {
                    "campaign_id": null,
                    "country_code": "GB",
                    "country_name": "United Kingdom",
                    "location_id": 21,
                    "place_name": "CANDELARIA",
                    "postal_code": "1234",
                    "price": 11.1,
                    "quantity": 10,
                    "status": "Queued"
                }
            ],
            "custom_string": "Custom String",
            "date_added": 1478141522,
            "file_name": "79483D26-D9E3-4051-93BB-2B9AFC612F52.pdf",
            "message_id": "C45638E1-62A9-4A31-AABF-E30957151BC5",
            "name": "My Campaign",
            "schedule": 1478141522,
            "size": "A5",
            "source": "My Source.rest.v3",
            "status": "Queued",
            "user_id": 1
        },
        "total_price": 155.4,
        "total_quantity": 32
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "New direct mail campaign created."
}

Request

Body Params application/json

areas

array

optional

List of location where you want to send your campaign, and the quantity per location.

file_urls

array

required

Campaign file urls. You can submit max 2 file urls.

name

string

required

Campaign name.

schedule

number

optional

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

size

string

required

Campaign file size. It can be A5 or DL.

source

string

optional

Your method of sending e.g. 'wordpress', 'php', 'c#'.

Examples

Responses

🟢200OK

application/json

Body

object {0}

List Direct Mail Campaigns

Create New Campaign