Skip to content
Changelog

Report a bug

Campaign Cleaner integration: operations for AI agents

Campaign Cleaner connects to Type.com as an integration. This page lists the 23 operations documented for Claude and Codex in Type.com: 15 read, 5 write, 3 destructive.

About Campaign Cleaner

Campaign Cleaner is a tool designed to optimize email campaigns by ensuring compatibility across email clients, improving deliverability, and enhancing overall performance.

Categories: Email & Messaging

How to connect Campaign Cleaner to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

23 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

23 operations listed.

Campaign Cleaner

  • Read

    Get Campaign Status

    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 getcampaignstatus API. When you see a 'completed' status, you can call the getcampaign API to retrieve the results.

  • Read

    Get Campaign List

    The getcampaignlist API endpoint allows you to get the status of all the campaigns you have saved on Campaign Cleaner. Header: X-CC-API-Key: Your API Key Response: campaignlist: - id: The campaign id that will be used in other API calls. - campaignname: The name of the campaign.

  • Read

    Get Campaign

    The getcampaign API allows you to retrieve any of your Saved Campaigns in Campaign Cleaner. 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.

  • Read

    Get Credits

    The getcredits API will show you how many credits you currently have available. Credits are consumed by calling the sendcampaign API endpoint (1 credit per campaign) and the createinboxtest API endpoint (1 credit per test). Inbox Placement Monitor endpoints don't use credits.

  • Read

    Get Campaign PDF Analysis

    The getcampaignpdfanalysis 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.

  • Read

    Get Inbox Test Results

    The getinboxtestresults API allows you to retrieve the placement results for an inbox test created via the createinboxtest API. Results are populated as seed mailboxes receive your campaign, so you may call this endpoint multiple times until the status is Completed.

  • Write

    Send Campaign

    The sendcampaign API Endpoint allows you to send in a campaign to be processed and analyzed by Campaign Cleaner. Below is the list of settings that can be set, all optional settings, if not specified will default to the bold/italicized setting.

  • Write

    Create Inbox Test

    The createinboxtest API allows you to create a new inbox placement test. Once created, you will receive a list of seed email addresses to send your campaign to.

  • Destructive

    Delete Campaign

    The deletecampaign API permanently deletes one of your saved campaigns, including its analysis. This can't be undone. Header: X-CC-API-Key: Your API Key Request Body: Required: campaign: - id: The campaign id returned by sendcampaign or getcampaignlist.

Inbox Placement Monitor

  • Read

    Get Monitor Seeds

    The monitorgetseeds API returns the seed addresses for the Inbox Placement Monitor. Add these addresses to your normal sends as regular To recipients (not Cc or Bcc), sending from a verified domain, and every copy that reaches a seed is recorded with the folder it landed in.

  • Read

    Get Monitor Domains

    The monitorgetdomains API lists the domains on your account, their verification status, and your limits. Only mail sent From a verified domain (or one of its subdomains) is recorded.

  • Read

    Get Monitor Messages

    The monitorgetmessages API returns every stored copy of your mail that reached a seed, newest first, with where it landed and its authentication results. Messages are kept for 30 days. Parameters can be sent in the query string, or in a JSON body with POST.

  • Read

    Get Monitor Message

    The monitorgetmessage API returns one stored message with its authentication details, selected headers and a text preview, and optionally the original message. Header: X-CC-API-Key: Your API Key Parameters: Required: - messageid: From monitorgetmessages.

  • Read

    Get Monitor Placement Summary

    The monitorgetsummary API returns the inbox and spam rate overall and per provider. inboxrate counts Gmail tabs (Promotions, Updates, ...) as inbox, like the dashboard. Rates are null when there is no mail.

  • Read

    Get Monitor Usage

    The monitorgetusage API shows how many messages have been stored this billing period. Limits reset on your billing date (the 1st of the month, UTC, without a subscription). A null limit means unlimited.

  • Read

    Get Monitor Alerts

    The monitorgetalerts API returns your alert rules and the 50 most recent alerts. Each problem is reported once per domain and provider and is resolved when mail lands in the inbox again.

  • Write

    Add Monitor Domain

    The monitoradddomain API adds a domain to your account. Publish the returned DNS TXT record, then call monitorverifydomain. Freemail and shared sending domains (gmail.com, sendgrid.net, ...) can't be added. Requires an active plan that includes Inbox Placement Monitor.

  • Write

    Verify Monitor Domain

    The monitorverifydomain API checks the DNS TXT record for a pending domain. DNS changes can take a while to appear; if verified is false, try again later. Limit: 30 attempts an hour. Requires an active plan that includes Inbox Placement Monitor and a role other than User.

  • Write

    Save Monitor Alert

    The monitorsavealert API creates an alert (no alertid, returns 201) or replaces an existing one (alertid, returns 200). Alerts can only go to the account owner, your team members, or an address at one of your verified domains (monitored or alert domains).

  • Destructive

    Remove Monitor Domain

    The monitorremovedomain API removes a domain. Its stored messages and its alerts are deleted immediately and can't be recovered. Requires an active plan that includes Inbox Placement Monitor and a role other than User.

  • Destructive

    Delete Monitor Alert

    The monitordeletealert API deletes an alert and its alert history. Requires an active plan that includes Inbox Placement Monitor and a role other than User. Header: X-CC-API-Key: Your API Key Request Body: Required: - alertid: The alert to delete.

Credits

  • Read

    GET /api/v1/Credits

    GET /api/v1/Credits

Verify

  • Read

    GET /api/v1/verify

    GET /api/v1/verify

See How connections work for access and permissions, or browse all integrations.