Update Email Campaign

PUT

/email-campaigns/{email_campaign_id}

Email Marketing

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://rest.clicksend.com/v3/email-campaigns/1' \
--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": {
        "abuse_count": 0,
        "body": "<p>This is a test</p>",
        "body_plain_text": "This is a test",
        "click_count": 0,
        "custom_string": "",
        "date_added": "1458011424",
        "email_campaign_id": 69,
        "from_email_address_id": 2,
        "from_name": "From name",
        "hard_bounce_count": 0,
        "list_id": 456,
        "name": "John Doe",
        "open_count": 0,
        "schedule": "13213213212",
        "send_count": 0,
        "soft_bounce_count": 0,
        "status": "Scheduled",
        "subaccount_id": 1038,
        "subject": "Lorem Ipsum",
        "template_id": 31,
        "unsubscribe_count": 0,
        "user_id": 1201
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Email campaign has been updated."
}

Request

Path Params

email_campaign_id

number

required

The email campaign id you want to access.

Example:

Body Params application/json

from_email_address_id

number

optional

The allowed email address id.

from_name

string

optional

The name that will appear on the email.

list_id

number

optional

The list id you want to access.

name

string

optional

The name of the sender.

schedule

number

optional

Leave blank for immediate delivery. Will replace existing schedule (even if left blank). Your schedule time as a unix timestamp.

subject

string

optional

The subject of the email campaign.

template_id

number

optional

The template id you want to use.

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get Specific Email Campaign

Cancel Email Campaign