Update an email campaign

put https://api.brevo.com/v3/emailCampaigns/{campaignId}

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

campaignId

int64

required

Id of the campaign

Body Params

Values to update a campaign

tag

string

Tag of the campaign

sender

object

Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example:
{"name":"xyz", "email":"example@abc.com"}
{"name":"xyz", "id":123}

name

string

Name of the campaign

htmlContent

string

Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty

htmlUrl

url

Url which contents the body of the email message. REQUIRED if htmlContent is empty

scheduledAt

string

UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ).
Prefer to pass your timezone in date-time format for accurate result.
If sendAtBestTime is set to true, your campaign will be sent according
to the date passed (ignoring the time part).

subject

string

Subject of the campaign

previewText

string

Preview text or preheader of the email campaign

replyTo

string

Email on which campaign recipients will be able to reply to

toField

string

To personalize the To Field. If you want to include the first
name and last name of your recipient, add {FNAME} {LNAME}. These contact
attributes must already exist in your Brevo account. If input parameter
params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

recipients

object

Segment ids and List ids to include/exclude from campaign

attachmentUrl

url

Absolute url of the attachment (no local file).
Extension allowed:

xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'

inlineImageActivation

boolean

Defaults to false

Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.

mirrorActive

boolean

Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign

recurring

boolean

Defaults to false

FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times

footer

string

Footer of the email campaign

header

string

Header of the email campaign

utmCampaign

string

Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed

params

object

Pass the set of attributes to customize the type classic campaign. For example: {"FNAME":"Joe", "LNAME":"Doe"}. Only available if type is classic. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField

sendAtBestTime

boolean

Set this to true if you want to send your campaign at best time.
Note:- if true, warmup ip will be disabled.

abTesting

boolean

Defaults to false

Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. subjectA, subjectB, splitRule, winnerCriteria & winnerDelay will be considered when abTesting is set to true.
subjectA & subjectB are mandatory together & subject if passed is ignored. Can be set to true only if sendAtBestTime is false.
You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B

subjectA

string

Subject A of the campaign. Mandatory if abTesting = true.
subjectA & subjectB should have unique value

subjectB

string

Subject B of the campaign. Mandatory if abTesting = true.
subjectA & subjectB should have unique value

splitRule

int64

1 to 50

Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else

winnerCriteria

string

Choose the metrics that will determinate the winning version. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, winnerCriteria is ignored if passed

winnerDelay

int64

1 to 168

Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, winnerDelay is ignored if passed

ipWarmupEnable

boolean

Defaults to false

Available for dedicated ip clients. Set this to true if you wish to warm up your ip.

initialQuota

int64

Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.

increaseRate

int64

0 to 100

Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.

unsubscriptionPageId

string

Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.

updateFormId

string

Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.

emailExpirationDate

object

To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.

Responses

204

Email campaign updated

Language

Credentials

Header


xxxxxxxxxx
12
1
curl --request PUT \
2
     --url https://api.brevo.com/v3/emailCampaigns/campaignId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "inlineImageActivation": false,
8
  "recurring": false,
9
  "abTesting": false,
10
  "ipWarmupEnable": false
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'

400bad request

404Campaign ID not found