Our API - Everything You Need To Know

Documentation

API Reference

Dashboard

Support

Explore Campaign Cleaner's API to unlock the full potential of your email marketing campaigns. Enhance efficiency, integration, and performance.

API Information

Keep your email marketing campaigns in top shape with Campaign Cleaner. Optimize deliverability, design, and performance for better results.

Campaign Cleaner

Email Campaign Analysis provides a powerful tool for email marketers to analyze and optimize their HTML code.

Campaign Analysis

Enhance the performance and deliverability of your email campaigns with advanced settings. Optimize your emails for better results.

Settings

Keep track of your email campaign optimizations with saved campaigns. Easily access previous improvements to streamline your email marketing efforts.

Saved Campaigns

Submitting campaigns through email to Campaign Cleaner is a simple and convenient way to optimize your email campaigns.

Import Campaigns

Prevent your emails from getting flagged as spam with spam trigger detection. Identify and eliminate content that triggers spam filters.

AI Spam Keyword Detection

Learn why Alt and Title attributes are necessary in email and how they can improve the accessibility and deliverability of your email content.

Alt and Title Attribute Management

Improve your email deliverability by detecting background images that could affect rendering. Optimize your campaigns for better inbox placement.

Background Image Detection

Blacklist Link Recursion Checking helps to avoid having your email flagged as spam by checking if any of the links in your email have been blacklisted.

Blacklisted Link Checker

Removing unnecessary classes and IDs in email delivery can reduce file size and load time, improving deliverability and open rates.

Classes and ID Removal

Control and non-printable character removal is the process of removing non-printable characters from a text document.

Control and Non-Printable Characters

Relative references are not suitable for emails because the absolute path will be of the URL where the email is opened, not where image is stored.

Convert CSS Attributes To Style

Relative references are not suitable for emails because the absolute path will be of the URL where the email is opened, not where the image is stored.

Converting Relative URLS

CSS Inlining is a technique used in email marketing to boost delivery rates by embedding CSS styles directly into the HTML code.

CSS Inliner

Replace accented characters with their plain ASCII equivalent to ensure compatibility across email clients and avoid spam filters.

Diacritics Character Replacement

Preview your email campaigns across all popular devices and clients. Ensure flawless display and optimize your design for better inbox presentation.

Email Client Inbox Previews

Improve your email inboxing rates by adjusting font colors. Learn how color choices impact deliverability and avoid spam filters.

Font Color Adjustments

Enforcing min and max font sizes in emails can boost deliverability and accessibility. Ensure readability and optimal display across all devices.

Font Size Enforcement

Converting H tags to P tags in email is crucial because many email clients, including Gmail and Yahoo, strip out the styles associated with H tags.

H to P Tag Conversion

 Find out why height attributes can cause rendering issues and how removing them can help ensure consistent rendering across devices.

Height Attribute Removal

Removing HTML comments from emails can improve email deliverability, reduce email file size, and enhance email security.

HTML Comment Removal

Using HTML entities in emails helps avoid display issues, rendering problems, and security risks, ensuring your content appears as intended across clients.

HTML Entities

HTML fragments in email refer to sections of HTML code that can be reused across multiple email campaigns.

HTML Fragments

HTML Minifier is a tool that removes unnecessary characters and optimizes HTML code, reducing its size and improving its loading time. 

HTML Minifier

HTML sanitizing is the process of cleaning up and validating HTML code to remove any potentially malicious or harmful elements.

HTML Sanitizer

Improve email deliverability and rendering consistency by removing inherited CSS from your HTML emails.

Inherited CSS Removal

Removing large width attributes on elements other than images and tables in your HTML email can improve email performance and deliverability.

Large Width Removal

Ensure your email campaigns are running smoothly with our broken link checker tool. Scan all links in your emails and quickly identify any broken links.

Link Summary

Improve email deliverability and avoid spam filters by replacing non-ASCII characters with their ASCII equivalents.

Non-ASCII Character Replacement

Improve email deliverability with Oversized Image Detection. Detect and resize large images to prevent slow loading, broken layouts, and spam filtering.

Oversized Images

Improve email deliverability with Poor Delivery CDN detection. Learn how removing poor CDNs from campaigns can prevent inboxing issues and enhance performance.

Poor Delivery CDN Detection

Optimize your email's preheader text for clarity and engagement, ensuring your message makes an impact from the first glance.

Preheader Management

In email marketing, attention to punctuation, capitalization, and H tags can significantly impact campaign effectiveness and engagement.

Punctuation, Caps, and H Tags

Optimize your email campaign performance with Campaign Cleaner's image resizing and hosting services for fast loading and a perfect display across devices.

Resize and Host

Use Campaign Cleaner to send test emails and refine your campaign for maximum impact and deliverability.

Send Previews

Learn the importance of setting max-width for images in email design. Enhance user experience, performance, and avoid display issues across email clients.

Set Max-Width of Images

SpamAssassin is a widely-used open-source software utility that evaluates and filters email to identify spam, also known as junk or unsolicited bulk email.

SpamAssassin Score

Learn how wrapping your email campaign in a div container with default CSS styles enhances visibility and gives you more control over its appearance.

Surrounding HTML Div

Convert HTML tables to DIVs to improve email rendering and accessibility. Enhance deliverability, readability, and compatibility across devices and clients.

Tables to Divs Conversion

Text-To-Image Analysis in email detects images containing text, increasing accessibility and inbox placement. Optimize your campaigns with Campaign Cleaner.

Text to Image Analysis

Improve email deliverability with text-to-link analysis. Learn how to optimize your emails by identifying and reducing excessive links.

Text to Link Analysis

Spam filters often regard unsecured links with suspicion, potentially perceiving your email as a security risk.

Unsecured Links

Learn about the limitations of different image types in emails and why they may be unsupported across email clients, impacting your campaign's visual appeal.

Unsupported Image Detection

Discover the power of Campaign Cleaner API integration, your ultimate solution for streamlining and optimizing your marketing campaigns.

All Integrations

Enhance your email marketing campaigns with our advanced API Management solution. Seamlessly integrate, manage and optimize your APIs to deliver personalized email content, automate campaigns, and monitor results.

API Management

Boost your email campaign performance with our CDN Management Tools for email images - ensure faster loading times, improved reliability, and higher open rates

CDN Management

Effectively manage your users with Campaign Cleaner. Gain control over user permissions, roles, and settings, ensuring team collaboration and security.

Manage Users

Discover comprehensive security measures, easy-to-follow guidelines, and advanced tools to safeguard your account against unauthorized access.

Securing Your Account

HTTP response status codes indicate whether a specific HTTP request has been successfully completed.

HTTP Response Status Codes

Embedded images in emails can also be included as attachments rather than being directly encoded in the HTML body.

Embedded Images

Discover key things to be aware of when using Campaign Cleaner. Learn about quirks and tips to optimize your email campaigns for the best results.

Quirks

This dedicated section provides detailed insights into our terms of service, privacy policy, user agreements, and other essential legal documents.

Legal Policies

Campaign Cleaner LLC is dedicated to protecting your privacy. Learn how we safeguard your personal information and ensure compliance with privacy regulations.

Privacy Policy

Read our Terms of Use to understand the guidelines, responsibilities, and conditions for using our services.

Terms of Use

Learn about our GDPR policy and commitment to protecting your personal data. We ensure compliance with data privacy regulations for your security.

GDPR Policy and Commitment

Learn your rights under the California Consumer Privacy Act (CCPA) and how Campaign Cleaner LLC ensures your privacy protection.

California Consumer Privacy Act (CCPA)

Explore our Acceptable Use Policy to understand the guidelines that ensure a safe and respectful digital environment.

Acceptable Use Policy

Learn about our subprocessors and how we ensure data protection and compliance with privacy regulations in our services.

Subprocessors

We are prepared to finalize the Data Processing Addendum (DPA) with our customers as mandated by the European Union General Data Protection Regulation (GDPR).

Data Processing Addendum

Read our Cookie Policy to understand how we use cookies to improve your experience and ensure compliance with privacy regulations.

Cookies Policy

We offer a robust collection of APIs to allow you to integrate its functionality into your email marketing software and tools.

API Documentation

The **delete_campaign** API endpoint allows you to delete any of the campaigns in your saved campaigns in [Campaign Cleaner](https://campaigncleaner.com).
#### Header:
**X-CC-API-Key**: Your API Key
#### Request Body:

**campaign**:

- **id**: The campaign id that will be deleted.
 

#### Response:

- **status**: _success_ or _failure,_ failures can occur when the **campaign_id** doesn't exists or was deleted.
 

In the event of an error, you will get an "**error**:" response, with a description of the reason.

Delete Campaign

The **get_campaign_list** API endpoint allows you to get the status of all the campaigns you have saved on [Campaign Cleaner](https://campaigncleaner.com).
#### Header:
**X-CC-API-Key**: Your API Key

#### Response:

**campaign_list**:

- **id**: The campaign id that will be used in other API calls.
- **campaign_name**: The name of the campaign.
- **status**: The status will be either _processing_, _completed_, or _paused_
- **date_added**: The date and time your campaign was saved or submitted to Campaign Cleaner.
 

If the **status** is _completed_, you will be able to retrieve the campaign via the **get_campaign** API

In the event of an error, you will get an "**error**:" response, with a description of the reason

Get Campaign List

After submitting a campaign to be corrected and analyzed it can take up to a minute to finalize the results. You can check the status of your campaign with the **check_campaign_status** API. When you see a 'completed' status, you can call the **get_campaign** API to retrieve the results.
#### Header:
**X-CC-API-Key**: Your API Key
#### Request Body:

**campaign**:

- **id**: The Campaign ID that you want to get the status for.
 

#### Response:

**campaign_list**:

- **id**: The campaign id that will be used in other API calls.
- **campaign_name**: The name of the campaign.
- **status**: The status will be either _processing_, _completed_, or _paused_
- **date_added**: The date and time your campaign was saved or submitted to [Campaign Cleaner](https://campaigncleaner.com).
 

If the **status** is _completed_, you will be able to retrieve the campaign via the **get_campaign** API

In the event of an error, you will get an "**error**:" response, with a description of the reason

Get Campaign Status

The **get_campaign** API allows you to retrieve any of your Saved Campaigns in [Campaign Cleaner](https://campaigncleaner.com). The response below is a real example of a newsletter that "Postman" sent us, overall it's a pretty good newsletter with a few issues, mainly image size and a couple of broken links.
#### Header:
**X-CC-API-Key**: Your API Key
#### Request Body:
_Required:_
**campaign**:

- **id**: The campaign id that will be used in other API calls.
 
_Optional:_
**campaign**:
- **minimize_html**: (true/false) If true (default), removes all whitespace, tabs, etc. Condensing the HTML.
#### Response:

**campaign:**

- **adjust_font_colors**: (true/false), If true, certain bright colors are spam triggers, like "**red**" or "**#FF0000**", was adjusted to a slightly different color like "**#FF0101"**, it will look the same, but won't trigger some spam filters.
- **adjust_font_size**: (true/false) If true, The min and max font size defined below in pixels were applied. If your newsletter contains larger or small font's it was adjusted to the min/max you define.
- **all_capitalized_word_ratio**: (double) The ratio of all capitalized words to total words in your campaign.
- **all_capitalized_words**: (integer) The number of capitalized words found in your campaign.
- **all_capitalized_word_max_acceptable_ratio**: (double) The max acceptable ratio of all capitalize words to total words in your campaign.
- **all_link_list:** (list of links) All the links found in the campaign (images, text, etc.)
   - **link_url**: (string) The URL or location of the broken link.
   - **link_status**: (string) The status code of the link, please view the status guide below.
   - **link_redirected_url**: (string) The location of where the link was redirected to, empty string, if it wasn't redirected.
   - **link_is_image**: (true/false) True, if the link is used as an image.
   - **link_is_broken**: (true/false) True, if the link was non-functional at the time of the scan.
   - **link_initial**: (true/false) True, if the link was the initial link in the campaign, not an intermediate or final link, if redirected.
   - **link_count**: (integer) The number of times this link was found.
   - **link_secure:** (true/false) true, if the link is HTTPS.
   - **link_tel:** (true/false) true, if the link is tel:
   - **link_mailto:** (true/false) tru, if the link is mailto:
- **bg_images_found**: (integer) The number of background images found, some major email clients don't support background images.
- **bg_image_list**: (List of images) All the background images found
  - **image_url**: (string) The URL of where the image is located.
  - **image_size** (long) The size of the image in Kilobytes (KB)
  - **image_width**: (integer) The width of the image.
  - **image_height**: (integer) The height of the image.
  - **image_rendered_width**: (integer) The rendered width of the image.
  - **image_rendered_height**: (integer) The rendered height of the image.
  - **image_background**: (true/false) Will always be true, since this is a background image.
  - **image_type**: (Integer) 1=png, 2=jpeg, 3=gif, 4=bmp, 5=svg, 6=avif, 7=tif, 8=webp, 9=apng, 10=heic, 11=icon, 12=base64, -1=Unknown
- **blacklisted_links**: (list of blacklisted links) Links that are on blacklists and their properties.
  - **bl_url**: (string) The web address where the blacklist is located.
  - **bl_name**: (string) The name of the blacklist
  - **link_url**: (string) The link in the campaign that is on a blacklist, can be a redirected link.
- **blacklisted_links_found**: (integer) The total number of blacklisted links found.
- **broken_links**: (list of links) All the broken links found in the campaign.
  - **link_url**: (string) The URL or location of the broken link.
  - **link_status**: (string) The reason why the link was considered broken, please view the status guide below.
  - **link_redirected_url**: (string) The location of where the link was redirected to, empty string, if it wasn't redirected.
  - **link_is_image**: (true/false) true, if the link is used as an image.
  - **link_is_broken**: (true/false) true, if the link was non-functional at the time of the scan.
  - **link_initial**: (true/false) true, if the link was the initial link in the campaign, not an intermediate or final link, if redirected.
  - **link_count**: (integer) The number of times this link was found.
  - **link_secure:** (true/false) true, if the link is HTTPS.
  - **link_tel:** (true/false) true, if the link is tel:
  - **link_mailto:** (true/false) tru, if the link is mailto:
- **campaign_id**: The campaign id that will be used in other API calls.
- **campaign_html:** (string) The adjusted HTML of the campaign, with all the fixes that were selected.
- **campaign_name**: (string) The name the campaign was saved with.
- **campaign_summary**: (list of messages) A quick summary of some of the changes that were applied and some analysis highlights.
 - **apply_count**: (true/false) If true, the count column apples to the message as the number of occurrences found. If false, the count will be zero, and the message is a statement of what happened.
 - **count**: (integer) The total occurrences that was found or corrected.
 - **html_changed**: (true/false) Indicates if the Campaign HTML was changed to correct the issue.
 - **message**: (string) The change or analysis that took place that indicating something change or something should be looked into further.
- **convert_h_to_p_tags**: (true/false) If true, this will change all the H tags to P tags and set the correct font-size.
- **convert_tables_to_divs:** (true/false) **\-** This is an experimental feature to convert all the tables to divs, in certain instances with a complicated table structure you might need to edit the HTML. We recommend leaving this as false or not setting it.
- **custom_info**: The values you passed us when calling the **send_campaign** API
- **domains_scanned**: (array of strings) The domains that were scanned at different blacklists.
- **header_tags_count**: (integer) The number of header tags found in the campaign, header tags displays are not consistent across email clients, use "**div**" or "**p**" tags styled correctly instead.
- **host_extensionless_images:** (true/**false**) If true, images without extensions will be hosted on our CDN when the **resize_and_host** parameter is set to true. Typically, dynamically generated images lack extensions, though there are exceptions.
- **inline_css:** (**true**/false) When set to true, CSS styles are directly applied within the style attribute of each HTML element.
- **inline_css_important:** (true/**false**) When set to true, the `!important` flag will also be inlined with CSS styles. If you are using media queries, it is generally recommended to keep this set to false.
- **media_queries_important:** (**true**/false) When set to true, all media query styles will be marked with the `!important` flag. This ensures they can override any inline CSS without an `!important` flag.
- **image_count**: (integer) The total number of images found in your campaign including background images.
- **image_max_width**: (integer): The max-width style applied to all images in pixels.
- **images_missing_alt_attribute:** (integer) The number of images missing or have an empty **"alt"** attribute.
- **image_list**: (list of images) A list of all images found and their properties.
  - **image_url**: (string) The URL of where the image is located.
  - **image_size** (long) The size of the image in Kilobytes (KB)
  - **image_width**: (integer) The width of the image.
  - **image_height**: (integer) The height of the image.
  - **image_background**: (true/false) True, if this is a background image, otherwise
  - **image_type**: (Integer) 1=png, 2=jpeg, 3=gif, 4=bmp, 5=svg, 6=avif, 7=tif, 8=webp, 9=apng, 10=heic, 11=icon, 12=base64, -1=Unknown
  - **image_rendered_width**: (integer) The rendered width of the image.
  - **image_rendered_height**: (integer) The rendered height of the image.
  - **links_missing_title_attribute** : (integer) The number of links
missing the **"title"** attribute.
- **links_scanned**: (integer) The total number of links scanned, images, text, and redirects.
- **os_images_found**: (integer) The number of oversized images found in your campaign, slowing down the loading of your campaign.
- **pd_cdn_list**: (List of links on Poor delivery CDNs) Links that point to CDNs that are known to affect delivery.
   - **pd_cdn_name**: (string) The name of the CDN that can affect delivery.
   - **pd_cdn_url**: (string) The URL or Location the CDN uses to host content.
- **min_font_size_allowed**: (A positive Integer, under 100) in pixels.
- **max_font_size_allowed**: (A positive Integer under 100) in pixels.
- **os_image_list**:(list of images) All the oversized images in the campaign
  - **image_url**: (string) The URL of where the image is located.
  - **image_size** (long) The size of the image in Kilobytes (KB)
  - **image_width**: (integer) The width of the image.
  - **image_height**: (integer) The height of the image.
  - **image_background**: (true/false) True, if this is a background image, otherwise false.
  - **image_type**: (Integer) 1=png, 2=jpeg, 3=gif, 4=bmp, 5=svg, 6=avif, 7=tif, 8=webp, 9=apng, 10=heic, 11=icon, 12=base64, -1=Unknown
  - **image_rendered_width**: (integer) The rendered width of the image.
  - **image_rendered_height**: (integer) The rendered height of the image.
- **pd_cdns_found**: (integer) The number of content delivery networks found, known to cause adverse delivery issues.
- **pd_cdns_link_count**: (integer) The total number of links pointed to content delivery networks know to cause adverse delivery issues.
- **preserve_media_queries**: (true/false) True, if all media queries were preserved.
- **relative_links_base_url**: If set, this needs to be a full base URL like "[https://campaigncleaner.com/"](https://campaigncleaner.com/), if your email campaign has any relative paths, it will be converted to an absolute URL. In most instances, you won't need to set this.
- **remove_successive_punctuation**: (true/false) if true, this will remove succession punctuation like ..., !!!!, $$$ to a single occurrence.
- **remove_css_inheritance**: (true/false) If true, removes all elements of CSS that are inherited. Once CSS is inlined, the inherited CSS will be removed, for example if font-size of a parent tag is 15 pixels, there is no need for the font-size of the child tag to be specified as 15 pixels because it's inherited or computed from the parent tag, this reduces the size of your HTML Campaign.
- **remove_classes_and_ids**: (_true_/false) If true, all the class and ID attributes after CSS Inlining was removed.
- **remove_comments**: (true/false) If true, comments were stripped from both CSS and HTML. Comments are invisible in HTML and can trigger spam filters.
- **remove_control_non_printable:** (true/false) If True, call non-printable and control characters are removed.
- **remove_image_height:** (true/false) if true, the height style was removed from all images, preventing any image distortions.
- **remove_large_widths_over**: (integer) Experimental: If sets removes all defined widths over the value set on non images and table tags.
- **replace_diacritics**: (true/false) If true, diacritic characters like á were replaced with a normal characters equivalent.
- **replace_non_ascii_characters**: (true/false) If true, all non-ascii characters were replaced with their ascii equivalent. For example, ❝ was replaced with **".** Non-ascii characters is of of the major spam trigger.
- **resize_and_host**: (true/false) If true, all eligible images were resized, converted, and hosted on our CDN. Read more about this here: [Resize And Host](https://docs.campaigncleaner.com/features-settings/resize-and-host)
- **spam_words_count**: (integer) The total number of spam words found in your campaign.
- **spam_keyword_list**: (List of Spam Keywords) (keyword (string), count (integer) Array of all spam keywords found and the number of times they were found.
  - **keyword**: The spam Keyword or phrase.
  - **count**: The number of occurrences of the spam keyword.
- **spam_keyword_ratio**: (double) The spam keyword ratio of the campaign.
- **spam_keyword_max_acceptable_ratio**: (double) The max acceptable ratio for spam keywords for any campaign.
- **successive_currency_marks**: (integer) The number of successive currency marks found "$$".
- **successive_exclaimations**: (integer) The number of successive exclamation points found "!!".
- **successive_question_marks**: (integer) The number of successive question marks found "??".
- **successive_periods**: (integer) The number of successive periods found "..".
- **surrounding_div**: A surrounding "div" added to your html with the following styles added.
   - **max_width**: The max-width style in pixels applied to the surrounding "div".
   - **text_align**: (left, center, right) All content within the surrounding "div" will be aligned according to the specified style. However, this can be over-written but setting "text-align" property on inner tags within the "div" to customize the appearance of your email.
   - **font_size**: The pixel size that set in the surrounding div to adhere to, this adds an "!important" to all font-sizes that are set on any tag in the HTML to maintain the font you want. While setting all unspecified font sizes to the size you choose.
   - **center_to_parent**: (true/false) If true, this will enable the surrounding "div" to be centered in any parent tags in which it is placed. This is particularly helpful when inserting an HTML snippet into a template
  - **text_link_max_acceptable_ratio**: (double) the max acceptable text
to link ratio for any campaign.
- **text_link_ratio**: (double) The text to link ratio of your campaign.
- **text_image_max_acceptable_ratio**: (double) the max acceptable text to image ratio for any campaign.
- **text_image_ratio**: (double) The text to image ratio of your campaign.
- **total_word_count**: (integer) The total number of words found in your campaign.

#### Additional Information:

**HTTP Status Codes:** [https://developer.mozilla.org/en-US/docs/Web/HTTP/Status](https://developer.mozilla.org/en-US/docs/Web/HTTP/StatusIn)

In addition to status codes listed in the document above.

| **Status Code** | **Description** |
| --- | --- |
| 97 | Telephone Links start with tel: |
| 98 | Email links, starts with mailto: |
| 99 | Invalid URL - The provided website address is not valid. It may be a partial address, missing the necessary protocols (http or https), or has an incorrect format. |

Get Campaign

The **get_campaign_pdf_analysis** API allows you to retrieve the analysis report for any of your Saved Campaigns in Campaign Cleaner.
#### Header:
**X-CC-API-Key**: Your API Key
#### Request Body:
**campaign**:
- **id**: The campaign id that will be used in other API calls.
#### Response:
An Application/pdf stream.

Get Campaign PDF Analysis

The **get_credits** API will show you how many credits you currently have available. Credits are consumed by calling the **send_campaign** API endpoint.

#### Response:

- **Credits**: The amount of available credits you have on your account.
 

In the event of any other error, you will get an "**error**:" response, with a description of the reason.

Get Credits

The **send_campaign** API Endpoint allows you to send in a campaign to be processed and analyzed by [Campaign Cleaner](https://campaigncleaner.com). Below is the list of settings that can be set, all optional settings, if not specified will default to the bold/italicized setting.

All submitted campaigns will be sanitized.
#### Header:
**X-CC-API-Key**: Your API Key
#### Request Body:

_Required:_

**send_campaign**:

- **campaign_html** : The full HTML of your campaign
- **campaign_name**: The name of your campaign - campaign name must pass our sanitization checks.
 

Campaigns are normally processed in under 2 minutes, in most instances in a few seconds. But in some cases with very large campaigns with lots of images and links it can take longer to check those links for blacklists, redirects. image sizes and more. Depending on the server where those links resources are located it can take longer. The send campaign, will return a campaign ID once we received it, you can use that campaign ID to check on the status, and retrieve your campaign when it's finished processing or you can supply us a webhook URL and we will send the results to you automatically.

_Optional:_

**send_campaign**:

- **adjust_font_colors**: (_**true**_/false), If true, certain bright colors are spam triggers, like "**red**" or "**#FF0000**", will be adjusted to a slightly different color like "**#FF0101"**, it will look the same, but won't trigger some spam filters.
- **adjust_font_size**: (_**true**_/false) If true, you will be able to define the min and max font size allowed in pixels. If your newsletter contains larger or small font's it will adjust them to the min/max you define.
- **convert_h_to_p_tags**: (true/**false**) If true, this will change all the H tags to P tags and set the correct font-size.
- **convert_tables_to_divs:** (true/**false**) - This is an experimental feature to convert all the tables to divs, in certain instances with a complicated table structure you might need to edit the HTML. We recommend leaving this as false or not setting it.
- **custom_info:** This field is for you to pass any additional data you want to send us, it will also be passed back to you when you call the get_campaign API. It's limited to 500 characters. - It must pass our sanitization checks.
- **host_extensionless_images:** (true/**false**) If true, images without extensions will be hosted on our CDN when the **resize_and_host** parameter is set to true. Typically, dynamically generated images lack extensions, though there are exceptions.
- **inline_css:** (**true**/false) When set to true, CSS styles are directly applied within the style attribute of each HTML element.
- **inline_css_important:** (true/**false**) When set to true, the `!important` flag will also be inlined with CSS styles. If you are using media queries, it is generally recommended to keep this set to false.
- **media_queries_important:** (**true**/false) When set to true, all media query styles will be marked with the `!important` flag. This ensures they can override any inline CSS without an `!important` flag.
- **image_max_width:** (int) When this is specified, it will add an max-width style to all images. it is not desirable for the image width to exceed the default campaign width.
- **min_font_size_allowed**: (_**10**_) (A positive Integer, under 100) The **min_font_size** must be smaller or equal to the **max_font_size** in pixels
- **max_font_size_allowed**: (_**32**_) (A positive Integer under 100) The **max_font_size** must be larger or equal to the **min_font_size** in pixels
- **preserve_media_queries**: (_**true**_/false) True, if media queries should be preserved.
- **remove_classes_and_ids**: (_**true**_/false) If true, removes all the class and ID attributes after CSS Inlining.
- **remove_comments**: (_**true**_/false), If true, comments are stripped from both CSS and HTML. Comments are invisible in html and can trigger spam filters.
- **remove_css_inheritance**: (_**true**_/false) If true, removes all elements of CSS that are inherited. Once CSS is inlined, the inherited CSS will be removed, for example if font-size of a parent tag is 15 pixels, there is no need for the font-size of the child tag to be specified as 15 pixels because it's inherited or computed from the parent tag, this reduces the size of your HTML Campaign.
- **remove_control_non_printable:** (**true**/false) If true, all non-printable and control characters are removed.
- **remove_image_height:** (true/**false**) If true, the height style is removed from all images, preventing any image distortions. Only the width property should be set on images sent in emails.
- **remove_large_widths_over**: (integer) Experimental: If sets removes all defined widths over the value set on non images and table tags.
- **remove_successive_punctuation**: (true/**false**) If true, this will remove succession punctuation like ..., !!!!, $$$ to a single occurrence.
- **relative_links_base_url**: If set, this needs to be a full base URL like "[https://campaigncleaner.com/"](https://campaigncleaner.com/), if your email campaign has any relative paths, it will be converted to an absolute URL. In most instances, you won't need to set this.
- **replace_diacritics**: (**true**/false) If true, replaces diacritic characters like á with normal characters equivalent, if you're sending emails in English emails, this is a must.
- **replace_non_ascii_characters**: (**true**/false) If true, replaces all non-ascii characters with their ascii equivalent. For example, ❝ will be replaced with **".** Non-ascii characters is of of the major spam trigger.
- **resize_and_host**: (true/**false**) If true, we will resize, convert, and host all eligible images on our CDN. Please read our documentation here: [Resizing and Hosting](https://docs.campaigncleaner.com/features-settings/resize-and-host)
- **surrounding_div:** When you set any parameter of the surrounding div, it will add "div" tag around your html with the styles you set. This is helpful to set default styles and conditions that can affect the look of your html.
  - **max_width:** The max-width style applied to the surrounding "div" can be specified in pixels as an integer value. It is typically set to the desired maximum width of the campaign, which is commonly either 600 or 900 pixels.
  - **text_align**: (left, center, right) All content within the surrounding "div" will be aligned according to your specified style. However, you can use the "text-align" property on inner tags within the "div" to customize the appearance of your email.
  - **font_size:** The pixel size that you want everything in the surrounding div to adhere to, setting this, will add an "_!important"_ to the font-size in the surrounding "div". Font sizes that are set on any tag in the HTML will retain their original size. While all unspecified font sizes to the size you chose.
  - **center_to_parent:** (true/false) Using this feature will enable the surrounding "div" to be centered in any parent tags in which it is placed. This is particularly helpful when inserting an HTML snippet into a template.

- **webhook_url**: An endpoint that you provide us and when your campaign is fully processed we will send the results back that is found in the Get Campaign API. You can utilize the webhook section under API Management to troubleshoot and test your endpoint.
 
#### Header:
**X-CC-API-Key**: Your API Key
#### Response:

**campaign:**

- **id**: The campaign id that will be used to retrieve your campaign using the get_campaign API.

Campaign Managmement

Features & Settings

Integrations

Management

Account Info

References

Legal and Compliance

API Information

Our API - Everything You Need To Know

Campaign Managmement

Features & Settings

Integrations

Management

Account Info

References

Legal and Compliance

​Our API - Everything You Need To Know

Our API - Everything You Need To Know