Edit campaign

put

/1/newsletters/{domain}/campaigns/{campaign}

Edit an existing campaign

Path parameters

domain

requiredinteger

Unique identifier of the Domain

Examples:27773

campaign

requiredinteger

Unique identifier of the Campaign

Examples:77288

Body Parameters

application/json

content_htmlstring

Examples:example

email_from_addrstring

Examples:example

email_from_namestring

Examples:example

force_sendedboolean

langstring

Possible values:de_DEen_GBes_ESfr_FRit_IT

Examples:de_DE

preheaderstring

Examples:example

recipientsobject

MaxLength:5

subjectstring

Examples:example

template_idinteger

Examples:28694

tracking_linkboolean

tracking_openingboolean

tracking_utmobject

unsub_linkboolean

Response Body

application/json

resultstring

Possible values:successerrorasynchronous

Result of the HTTP request

Examples:success

datarequiredCampaign

Example request

                <?php
use GuzzleHttp\Client;

$client = new Client();
$headers = [
	'Authorization' => 'Bearer YOUR-TOKEN-HERE',
	'Content-Type' => 'application/json'
];

$body = '{
    "content_html": "example",
    "email_from_addr": "example",
    "email_from_name": "example",
    "force_sended": true,
    "lang": "de_DE",
    "preheader": "example",
    "recipients": {
        "all_subscribers": true,
        "emails": [
            "example"
        ],
        "expert": {
            "conditions": [],
            "id": 18996
        },
        "groups": {
            "exclude": [
                54950
            ],
            "include": [
                60364
            ]
        },
        "segments": {
            "exclude": [
                49768
            ],
            "include": [
                53944
            ]
        }
    },
    "subject": "example",
    "template_id": 28694,
    "tracking_link": true,
    "tracking_opening": true,
    "tracking_utm": {
        "utm_campaign": "example",
        "utm_medium": "example",
        "utm_source": "example"
    },
    "unsub_link": false
}';

$request = new Request('PUT', 'https://api.infomaniak.com/1/newsletters/{domain}/campaigns/{campaign}', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Example response

application/json

                
                    
{
"result":"success",
"data":{
"id":60201,
"status":"example",
"lang":"example",
"subject":"example",
"preheader":"example",
"email_from_name":"example",
"email_from_addr":"example",
"tracking_link":true,
"tracking_opening":false,
"tracking_utm":[
],
"next_step":"example",
"started_at":1743023513,
"created_at":1742664059
}
}