Please confirm your email address by clicking on the link below
", "type": "string" }, "htmlUrl": { "description": "Url which contents the body of the email message. **REQUIRED if htmlContent is empty**\n", "example": "https://html.domain.com", "format": "url", "type": "string" }, "increaseRate": { "description": "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%.\n", "example": 70, "format": "int64", "maximum": 100, "minimum": 0, "type": "integer" }, "initialQuota": { "description": "Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.\n", "example": 3000, "format": "int64", "type": "integer" }, "inlineImageActivation": { "default": false, "description": "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_.\n", "example": true, "type": "boolean" }, "ipWarmupEnable": { "default": false, "description": "**Available for dedicated ip clients**. Set this to true if you wish to warm up your ip.\n", "example": true, "type": "boolean" }, "mirrorActive": { "description": "Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign", "example": true, "type": "boolean" }, "name": { "description": "Name of the campaign", "example": "Newsletter - May 2017", "type": "string" }, "params": { "additionalProperties": {}, "description": "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**\n", "example": { "FNAME": "Joe", "LNAME": "Doe" }, "type": "object" }, "previewText": { "description": "Preview text or preheader of the email campaign", "example": "Thanks for your order!", "type": "string" }, "recipients": { "description": "Segment ids and List ids to include/exclude from campaign", "properties": { "exclusionListIds": { "description": "List ids which have to be excluded from a campaign", "items": { "example": 8, "format": "int64", "type": "integer" }, "type": "array" }, "exclusionSegmentIds": { "description": "Segment ids which have to be excluded from a campaign.\n", "items": { "example": 13, "format": "int64", "type": "integer" }, "type": "array" }, "listIds": { "description": "Lists Ids to send the campaign to. **Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty**\n", "items": { "example": 32, "format": "int64", "type": "integer" }, "type": "array" }, "segmentIds": { "description": "**Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it.** Segment ids to send the campaign to.\n", "items": { "example": 23, "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" }, "recurring": { "default": false, "description": "**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\n", "example": false, "type": "boolean" }, "replyTo": { "description": "Email on which campaign recipients will be able to reply to", "example": "support@myshop.com", "format": "email", "type": "string" }, "scheduledAt": { "description": "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).\n", "example": "2017-06-01T12:30:00+02:00", "type": "string" }, "sendAtBestTime": { "description": "Set this to true if you want to send your campaign at best time. Note:- **if true, warmup ip will be disabled.**\n", "example": true, "type": "boolean" }, "sender": { "description": "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}**\n", "properties": { "email": { "description": "Sender email from which the campaign emails are sent", "example": "newsletter@myshop.com", "format": "email", "type": "string" }, "id": { "description": "Select the sender for the campaign on the basis of sender id. **In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)**.\n", "example": 3, "format": "int64", "type": "integer" }, "name": { "description": "Sender Name from which the campaign emails are sent", "example": "Mary from MyShop", "type": "string" } }, "type": "object" }, "splitRule": { "description": "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\n", "example": 50, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" }, "subject": { "description": "Subject of the campaign", "example": "Discover the New Collection !", "type": "string" }, "subjectA": { "description": "Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value\n", "example": "Discover the New Collection!", "type": "string" }, "subjectB": { "description": "Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value\n", "example": "Want to discover the New Collection?", "type": "string" }, "tag": { "description": "Tag of the campaign", "example": "Newsletter", "type": "string" }, "toField": { "description": "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\n", "example": "{FNAME} {LNAME}", "type": "string" }, "unsubscriptionPageId": { "description": "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.\n", "example": "62cbb7fabbe85021021aac52", "type": "string" }, "updateFormId": { "description": "**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.\n", "example": "6313436b9ad40e23b371d095", "type": "string" }, "utmCampaign": { "description": "Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed", "example": "NL_05_2017", "type": "string" }, "winnerCriteria": { "description": "Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed\n", "enum": [ "open", "click" ], "example": "open", "type": "string" }, "winnerDelay": { "description": "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\n", "example": 50, "format": "int64", "maximum": 168, "minimum": 1, "type": "integer" } }, "type": "object" } } }, "description": "Values to update a campaign", "required": true }, "responses": { "204": { "content": {}, "description": "Email campaign updated" }, "400": { "$ref": "#/components/responses/errorModel" }, "404": { "$ref": "#/components/responses/errorModel" } }, "summary": "Update an email campaign", "tags": [ "Email Campaigns" ] } } }, "components": { "securitySchemes": { "api-key": { "description": "The API key should be passed in the request headers as `api-key` for authentication.", "in": "header", "name": "api-key", "type": "apiKey" }, "partner-key": { "description": "The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).", "in": "header", "name": "partner-key", "type": "apiKey" } }, "responses": { "errorModel": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "Error code displayed in case of a failure", "enum": [ "invalid_parameter", "missing_parameter", "out_of_range", "campaign_processing", "campaign_sent", "document_not_found", "not_enough_credits", "permission_denied", "duplicate_parameter", "duplicate_request", "method_not_allowed", "unauthorized", "account_under_validation", "not_acceptable", "bad_request", "unprocessable_entity", "Domain does not exist", "Contact email not found", "Attribute not found", "Category id not found", "Invalid parameters passed", "Record(s) for identifier not found", "Returned when query params are invalid", "Returned when invalid data posted", "Feed not found", "Campaign ID not found", "api-key not found", "DMARC policy requires domain authentication", "DNS records not properly configured", "Invalid OTP code provided", "OTP code has expired", "Domain already exists in your account", "The sum of all IP weights must equal 100", "Authentication failed", "Insufficient credits", "Request already processed" ], "example": "method_not_allowed", "type": "string" }, "message": { "description": "Readable message associated to the failure", "example": "POST Method is not allowed on this path", "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "bad request" } } }, "x-samples-languages": [ "curl" ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 91, "1": 104, "2": 180, "3": 205, "4": 240, "5": 82, "6": 207, "7": 0, "8": 3, "9": 36, "10": 63, "11": 142 } } } ```