> ## Documentation Index
> Fetch the complete documentation index at: https://docs.campaigncleaner.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Save Monitor Alert

> The **monitor_save_alert** API creates an alert (no **alert_id**, returns 201) or replaces an existing one (**alert_id**, 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). To alert someone else, invite them to your team first.

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:_
- **kind**: _spam_ (lands in spam), _notinbox_ (spam, Gmail tabs or Outlook's Other folder), _rate_ (inbox rate drops below **threshold**) or _auth_ (SPF, DKIM or DMARC fails).
_Optional:_
- **alert_id**: To update an existing alert.
- **domain_id**: One monitored domain; leave out or 0 for all.
- **provider_key**: One provider; leave out for all.
- **threshold**: _rate_ only: inbox rate in % (1-100, default 80).
- **min_messages**: _rate_ only: minimum messages in 24 hours before it can trigger (1-1000, default 5).
- **delivery**: **instant** or _digest_ (once a day).
- **recipients**: Array or comma separated string, up to 5. Empty sends to the account owner.
- **enabled**: (**true**/false).
#### Response:
- **alert**: The saved alert, as in **monitor_get_alerts**.



## OpenAPI

````yaml POST /v1/monitor_save_alert
openapi: 3.0.0
info:
  title: API DOCUMENTATION
  description: >-


    [Campaign Cleaner](https://campaigncleaner.com) is the leader in ensuring
    that your campaigns don't affect your IP and Domain reputation, it's the
    most advanced toolset you'll find that gives you all the tools you need to
    keep your campaigns within acceptable ratios of many email and spam
    filtering software and automatically fixes your HTML by sanitizing all
    non-email friendly attributes and inlines all your CSS to be compatible with
    every email client.


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


    The **{{api_key}}** is located in your account on [Campaign
    Cleaner](https://campaigncleaner.com) under **API Management API Keys.**


    The **Inbox Placement Monitor** endpoints (monitor_*) let you get the seed
    addresses, manage the domains you send from, read where every copy of your
    real campaigns landed, and manage placement alerts. They are included with
    The Works and the Inbox Placement Tester plan and don't use API credits.


    Use the navigation on the left to access the different API Endpoints.
  version: 1.0.0
servers:
  - url: https://api.campaigncleaner.com
security: []
tags:
  - name: Campaign Cleaner
    description: Campaign analysis, cleaning, credits and inbox placement tests.
  - name: Inbox Placement Monitor
    description: >-
      Track where your real campaigns land. Add the seed addresses to your
      normal sends, verify the domains you send from, then read placement per
      message or per provider and manage alerts. No API credits are used.
      Limits: 60 calls a minute per account and 120 a minute per client IP.
paths:
  /v1/monitor_save_alert:
    post:
      tags:
        - Inbox Placement Monitor
      summary: Save Monitor Alert
      description: >-
        The **monitor_save_alert** API creates an alert (no **alert_id**,
        returns 201) or replaces an existing one (**alert_id**, 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). To
        alert someone else, invite them to your team first.


        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:_

        - **kind**: _spam_ (lands in spam), _notinbox_ (spam, Gmail tabs or
        Outlook's Other folder), _rate_ (inbox rate drops below **threshold**)
        or _auth_ (SPF, DKIM or DMARC fails).

        _Optional:_

        - **alert_id**: To update an existing alert.

        - **domain_id**: One monitored domain; leave out or 0 for all.

        - **provider_key**: One provider; leave out for all.

        - **threshold**: _rate_ only: inbox rate in % (1-100, default 80).

        - **min_messages**: _rate_ only: minimum messages in 24 hours before it
        can trigger (1-1000, default 5).

        - **delivery**: **instant** or _digest_ (once a day).

        - **recipients**: Array or comma separated string, up to 5. Empty sends
        to the account owner.

        - **enabled**: (**true**/false).

        #### Response:

        - **alert**: The saved alert, as in **monitor_get_alerts**.
      parameters:
        - name: X-CC-API-Key
          in: header
          schema:
            type: string
          example: '{{api_key}}'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                alert_id:
                  type: integer
                kind:
                  type: string
                domain_id:
                  type: integer
                provider_key:
                  type: string
                threshold:
                  type: integer
                min_messages:
                  type: integer
                delivery:
                  type: string
                recipients:
                  type: array
                  items:
                    type: string
                enabled:
                  type: boolean
              example:
                kind: spam
                domain_id: 12
                provider_key: gmail.com
                delivery: instant
                recipients:
                  - ops@example.com
                enabled: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
              example:
                alert:
                  alert_id: 4
                  kind: spam
                  description: Mail from example.com at Gmail lands in spam
                  domain_id: 12
                  domain: example.com
                  provider_key: gmail.com
                  provider: Gmail
                  threshold: null
                  min_messages: null
                  delivery: instant
                  recipients:
                    - email: ops@example.com
                      receiving: true
                  enabled: true

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.