---
canonical_url: "https://docs.composio.dev/toolkits/cleverreach"
markdown_url: "https://docs.composio.dev/toolkits/cleverreach.md"
product: "platform"
version: null
last_updated: null
---

# CleverReach

CleverReach is an email marketing platform for managing subscriber groups, campaigns, reports, and forms.

- **Category:** marketing automation
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 87
- **Triggers:** 0
- **Slug:** `CLEVERREACH`
- **Version:** 00000000_00

## Tools

### Add Blacklist Entries

**Slug:** `CLEVERREACH_ADD_BLACKLIST_ENTRIES`

Add email addresses to the account-wide CleverReach blacklist in one provider batch request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Blacklist entries to add in one provider batch request. Each item requires a non-empty email and may include an optional comment; provide at least one item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Blacklist Entry

**Slug:** `CLEVERREACH_ADD_BLACKLIST_ENTRY`

Add one email address to the global blacklist when group_id is omitted, or to a group-specific blacklist when it is supplied. Comments are supported only for global entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to suppress globally or in the supplied group. |
| `comment` | string | No | Optional reason or note for a global blacklist entry. Group-specific blacklist entries do not support comments. |
| `group_id` | string | No | Optional group ID for a group-specific blacklist entry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Group Receiver Tags

**Slug:** `CLEVERREACH_ADD_GROUP_RECEIVER_TAGS`

IRREVERSIBLE AUTOMATION WARNING: add tags to one receiver through a specific group route. This can trigger THEA automation whose resulting effects cannot be undone by removing the tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to add. Prefix an origin followed by a period, for example 'batman.Good'. |
| `group_id` | string | Yes | Group ID whose receiver tags to update. Using this group-specific route can trigger irreversible THEA automation. |
| `receiver_id_or_email` | string | Yes | ID or exact email address of the receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Receiver Tags

**Slug:** `CLEVERREACH_ADD_RECEIVER_TAGS`

Add tags to one receiver through the account-wide receiver route. This action does not use a group route and does not trigger group-specific THEA automation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to add. Prefix an origin followed by a period, for example 'batman.Good'. |
| `receiver_id_or_email` | string | Yes | ID or exact email address of the receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Receivers

**Slug:** `CLEVERREACH_BULK_UPDATE_RECEIVERS`

Update existing receivers in one provider batch for a group. Carefully use lifecycle timestamps: nonzero deactivated makes a receiver inactive and zero can reactivate it. The plus variant applies relative numeric attributes and tag removals. Source is not changed for existing receivers. CleverReach does not document whether this batch is atomic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variant` | string ("standard" | "plus") | No | Use 'plus' to apply +/- numeric attribute changes and '-tag' or '-origin.*' tag removals; standard replaces supplied values. |
| `group_id` | string | Yes | Group ID. |
| `receivers` | array | Yes | Existing receivers to update by email address in one provider batch. Each item requires email and may include lifecycle timestamps, group/global attributes, tags, and orders; provide at least one item. Source is creation-only and is not changed for existing receivers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Upsert Receivers

**Slug:** `CLEVERREACH_BULK_UPSERT_RECEIVERS`

Create or update receivers in one provider batch for a group. Omitting registered, activated, and deactivated activates a new receiver; a nonzero deactivated value makes it inactive, while zero can reactivate it. The plus variant also applies relative numeric attributes and tag removals. CleverReach does not change source when upserting an existing receiver or document whether this batch is atomic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variant` | string ("standard" | "plus") | No | Use 'plus' to apply +/- numeric attribute changes and '-tag' or '-origin.*' tag removals; standard replaces supplied values. |
| `group_id` | string | Yes | Group ID. |
| `receivers` | array | Yes | Receivers to create or update in one provider batch. Each item requires email and may include lifecycle timestamps, source, group/global attributes, tags, and orders; provide at least one item. Source is set on creation only and is not changed for existing receivers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Receiver Email

**Slug:** `CLEVERREACH_CHANGE_RECEIVER_EMAIL`

Change one receiver's email address. If overwrite is true and the new email already belongs to another receiver, that existing receiver can be replaced.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | New receiver email address. |
| `overwrite` | boolean | No | Whether to overwrite a receiver that already has the new email. Enabling this can replace existing receiver data. |
| `receiver_id_or_email` | string | Yes | Numeric ID or exact current email address of the receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Receiver

**Slug:** `CLEVERREACH_CLONE_RECEIVER`

Copy a receiver to a target group under a new email address. If overwrite is true and that email already exists, its receiver data can be replaced.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address for the cloned receiver. |
| `overwrite` | boolean | No | Whether to overwrite an existing receiver with the target email. Enabling this can replace existing receiver data. |
| `target_group_id` | string | Yes | ID of the group to assign the cloned receiver to. |
| `receiver_id_or_email` | string | Yes | ID or exact email address of the receiver to clone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Receivers By Tags

**Slug:** `CLEVERREACH_COUNT_RECEIVERS_BY_TAGS`

Count receivers with one tag using a GET query, or with a tag constellation using a read-like POST. This action changes no receiver data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Tag to count in simple mode. |
| `mode` | string ("simple" | "complex") | No | Use simple for one required tag and optional exclusions; complex for a tag constellation. |
| `tags` | array | No | Tag constellation to count in complex mode. |
| `active` | boolean | No | In simple mode, count only active receivers. |
| `group_id` | string | No | Group ID to filter; omit or use '0' for all groups. |
| `except_tags` | array | No | Tags that receivers must not have in simple mode; sent comma-separated as 'except'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Attribute

**Slug:** `CLEVERREACH_CREATE_ATTRIBUTE`

Create a global or group-local CleverReach receiver attribute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | name for internal use |
| `type` | string ("text" | "number" | "gender" | "date") | Yes | type of data (text|number|gender|date) |
| `group_id` | string | No | ID of group; omit to create a global attribute. |
| `description` | string | No | Human-readable explanation of the receiver data stored in this attribute. |
| `default_value` | string | No | Value CleverReach uses when a receiver has no explicit value for this attribute. |
| `preview_value` | string | No | Example value shown in CleverReach when previewing the attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Filter

**Slug:** `CLEVERREACH_CREATE_FILTER`

Create a reusable CleverReach filter or segment in one receiver group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the reusable filter or segment. |
| `rules` | array | Yes | CleverReach filter rules; provide at least one. Each item requires field and logic (eq, neq, sm, bg, isnull, notisnull, contains, begins, ends, ismale, or isfemale) and may include condition; omit condition for null and gender logic. |
| `group_id` | string | Yes | group ID |
| `operator` | string ("AND" | "OR") | No | Operator used to combine all rules: AND requires every rule; OR requires any rule. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group

**Slug:** `CLEVERREACH_CREATE_GROUP`

Create a CleverReach receiver group and return its group ID for subsequent subscriber operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the receiver group. |
| `backup` | boolean | No | Whether CleverReach should back up the group. |
| `locked` | boolean | No | Whether to protect the group from deletion. |
| `receiver_info` | string | No | Optional notes describing the receivers in this group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Mailing

**Slug:** `CLEVERREACH_CREATE_MAILING`

Create a CleverReach mailing campaign definition. This action does not send the campaign, and CleverReach may confirm creation without returning its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Internal campaign name. |
| `tags` | array | No | Tags for the mailing. |
| `content` | object | No | Optional mail content. Set type to html, text, or html/text and supply html for html, text for text, or both bodies for html/text. |
| `subject` | string | Yes | Email subject line. |
| `settings` | object | No | Optional settings object with editor, open_tracking, click_tracking, link_tracking_url/type, google_campaign_name, unsubscribe_form_id, and category_id. |
| `receivers` | object | No | Optional audience object. groups is a non-empty list of CleverReach group IDs; filter is one CleverReach filter ID. Set one field and leave the other unset. |
| `sender_name` | string | Yes | Sender display name. |
| `sender_email` | string | Yes | Sender email address configured for the CleverReach account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Mailing Template

**Slug:** `CLEVERREACH_CREATE_MAILING_TEMPLATE`

Create a reusable CleverReach mailing template. CleverReach exposes no matching template-delete operation, so this creation is not reversible through this toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | Yes | Complete HTML code of the template. |
| `name` | string | Yes | Internal name of the template. |
| `tags` | array | No | Optional tags for the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create My Content

**Slug:** `CLEVERREACH_CREATE_MY_CONTENT`

Create a reusable CleverReach "My Content" item that references a URL. Use Delete My Content with the returned or discovered ID to remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | URL loaded by the reusable content item. |
| `cors` | boolean | No | Whether cross-origin access is enabled. |
| `icon` | string | No | Optional provider icon name. |
| `name` | string | Yes | Name of the "My Content" item. |
| `type` | string ("none" | "default" | "product" | "content" | "blog") | No | Optional provider content type. |
| `content_access_code` | string | No | Optional access code CleverReach sends when loading the content URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Receiver

**Slug:** `CLEVERREACH_CREATE_RECEIVER`

Create a subscriber in one CleverReach group. If lifecycle timestamps are omitted, CleverReach activates the receiver without sending double opt-in mail; the create response may briefly report the receiver as inactive. Optional group/global attributes, tags, and order history can be supplied at creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags to assign to the receiver. |
| `email` | string | Yes | Subscriber email address. |
| `orders` | array | No | Optional order history to record while creating the receiver. Each object uses provider order keys such as order_id, product_id, product, price, currency, quantity, and mailing_id; order_id identifies the order. |
| `source` | string | No | Origin of the subscriber record, such as website signup. |
| `group_id` | string | Yes | CleverReach group ID in which to create the receiver. |
| `activated` | string | No | Unix activation timestamp for immediate activation. Supplying it bypasses later double-opt-in activation; omit it when intentionally leaving a receiver pending double opt in. Omitting all three lifecycle timestamps activates a new receiver. |
| `attributes` | object | No | Group-local attribute values keyed by attribute name. |
| `registered` | string | No | Unix registration timestamp. For a new receiver, if registered, activated, and deactivated are all omitted, CleverReach sets registration and activation to the current time. |
| `deactivated` | string | No | Unix deactivation timestamp. A nonzero value makes the receiver inactive; zero can reactivate it during update or upsert. Omit unless deliberately changing activation state. |
| `global_attributes` | object | No | Global attribute values keyed by attribute name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Receiver Event

**Slug:** `CLEVERREACH_CREATE_RECEIVER_EVENT`

IRREVERSIBLE: permanently add an event to one CleverReach receiver. CleverReach provides no event deletion endpoint, so this action cannot undo or remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Event log type. CleverReach documents 'log' as the default. |
| `value` | string | Yes | Log data or text to record permanently. |
| `group_id` | string | No | Group ID for a group-specific event route; omit for the account-level route. |
| `receiver_id` | string | Yes | Receiver ID that will permanently receive the event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Receiver Order

**Slug:** `CLEVERREACH_CREATE_RECEIVER_ORDER`

MUTATES ORDER HISTORY: add an order to one CleverReach receiver globally or within a group. Use a unique order_id and verify before retrying.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | number | No | Single-product price; CleverReach documents 0 as the default. |
| `stamp` | integer | No | Unix order timestamp. CleverReach uses the current time when omitted. |
| `source` | string | No | Shop or source name. |
| `product` | string | Yes | Product name. |
| `currency` | string | No | Currency code; CleverReach documents EUR as the default. |
| `group_id` | string | No | Group ID for a group-specific order; omit for a global order. |
| `order_id` | string | Yes | Your order ID. |
| `quantity` | integer | No | Quantity bought; CleverReach documents 1 as the default. |
| `mailing_id` | string | No | Mailing ID for conversion tracking. |
| `product_id` | string | No | Your product ID. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address that will receive the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Receivers

**Slug:** `CLEVERREACH_CREATE_RECEIVERS`

Create up to 50 subscribers in one CleverReach group and return a separate success or failure result for each receiver. The batch is not atomic. When lifecycle timestamps are omitted, CleverReach activates each receiver without sending double opt-in mail, though create results may briefly show inactive. Each receiver may include attributes, tags, and order history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | CleverReach group ID in which to create the receivers. |
| `receivers` | array | Yes | Receivers to create. Each item requires email and may include source, registered/activated/deactivated timestamps, group-local attributes, global attributes, tags, and order history. Email addresses must be unique in this list. Provide 1-50 items; this action makes one provider request per receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Attribute

**Slug:** `CLEVERREACH_DELETE_ATTRIBUTE`

Permanently delete a CleverReach global or group-local attribute. This cannot be undone. CleverReach does not verify how the attribute was created; the caller must confirm the selected attribute is safe to delete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | No | Group ID; omit to delete a global attribute. |
| `attribute_id` | string | Yes | Exact CleverReach attribute ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blacklist Entries

**Slug:** `CLEVERREACH_DELETE_BLACKLIST_ENTRIES`

Permanently delete 1-50 exact email addresses sequentially from the global account blacklist, or only from one group's blacklist when group_id is supplied. This is bounded local orchestration over singular deletion endpoints, not a provider bulk operation and not atomic: successful deletions are not rolled back. Per-item provider failures do not stop later deletions; authentication, permission, and rate-limit failures stop the batch and mark remaining addresses not attempted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Ordered exact email addresses to delete. Locally limited to 50 because this orchestration makes one sequential provider request per address; 50 is not a provider bulk-operation limit. |
| `group_id` | string | No | Optional group ID. When omitted, every email is deleted from the global account blacklist; when supplied, every email is deleted only from this group's blacklist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blacklist Entry

**Slug:** `CLEVERREACH_DELETE_BLACKLIST_ENTRY`

Permanently remove one email address from the global CleverReach blacklist, or from a group blacklist when group_id is supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Exact email address to remove from the account-wide blacklist. |
| `group_id` | string | No | Optional group ID for a group-specific blacklist entry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Filter

**Slug:** `CLEVERREACH_DELETE_FILTER`

Permanently delete a CleverReach filter or segment. This cannot be undone. CleverReach does not verify how the filter was created; the caller must confirm the selected filter is safe to delete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | group ID |
| `filter_id` | string | Yes | filter ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `CLEVERREACH_DELETE_GROUP`

Permanently delete one CleverReach receiver group by ID. This operation cannot be undone, and CleverReach may reject deletion of a locked group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | CleverReach group ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Mailing Channel

**Slug:** `CLEVERREACH_DELETE_MAILING_CHANNEL`

Permanently delete one CleverReach mailing channel/category. This cannot be undone. Only use an exact, owner-approved disposable channel ID; this toolkit has no channel-creation operation for recovery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | Exact CleverReach channel/category ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete My Content

**Slug:** `CLEVERREACH_DELETE_MY_CONTENT`

Permanently delete one CleverReach "My Content" item by exact ID. This cannot be undone; delete only an item that the current workflow created or that the owner explicitly approved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content_id` | string | Yes | Exact CleverReach "My Content" item ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Receiver Account-Wide

**Slug:** `CLEVERREACH_DELETE_RECEIVER_ACCOUNT_WIDE`

Permanently delete one exact receiver at account level. This broader operation can remove the receiver from every group and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receiver_id_or_email` | string | Yes | Exact receiver ID or email address to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Receiver Order

**Slug:** `CLEVERREACH_DELETE_RECEIVER_ORDER`

IRREVERSIBLE: permanently delete one CleverReach receiver order globally or within a group using its internal id from LIST_RECEIVER_ORDERS, not the caller-defined order_id. Deleted order history cannot be restored by this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | No | Group ID for a group-specific order; omit for a global order. |
| `internal_order_id` | string | Yes | CleverReach internal order item ID from the id field returned by LIST_RECEIVER_ORDERS. This is not the caller-defined order_id. The legacy order_id parameter name remains accepted for compatibility. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address that owns the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Receivers Account-Wide

**Slug:** `CLEVERREACH_DELETE_RECEIVERS_ACCOUNT_WIDE`

Permanently delete a non-empty explicit list of exact receivers account-wide. This broader operation can remove them from every group and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receivers` | array | Yes | Non-empty list of exact receiver IDs or email addresses to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Report

**Slug:** `CLEVERREACH_DELETE_REPORT`

Permanently and irreversibly delete one report and its historical analytics by exact report or mailing ID. This data cannot be recreated independently. All links contained in the report will stop working after deletion, including unsubscribe links. Requires explicit confirmation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | Exact CleverReach report or mailing ID to permanently delete. |
| `confirm_delete` | boolean | Yes | Must be true to confirm irreversible deletion of the report analytics and disabling of all report links, including unsubscribe links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Filter Receivers

**Slug:** `CLEVERREACH_FILTER_RECEIVERS`

Return one bounded page of receivers matching temporary CleverReach filter rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rules` | array | Yes | Temporary CleverReach filter rule objects. |
| `groups` | array | No | Array of groups - leave empty for all available groups |
| `operator` | string ("AND" | "OR") | No | Default operator to combine rules (default: AND) |
| `order_by` | string | No | Provider field and direction, for example 'registered desc'. |
| `page_size` | integer | No | Maximum receivers in this page. Defaults to 10. |
| `active_only` | boolean | No | Whether to return only active subscribers. |
| `next_cursor` | string | No | Opaque continuation cursor; omit for the first page. |
| `include_details` | array | No | Additional receiver data to include. |
| `after_receiver_id` | string | No | Return only receivers whose ID is higher than this receiver ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attribute

**Slug:** `CLEVERREACH_GET_ATTRIBUTE`

Return one CleverReach global attribute by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_id` | string | Yes | CleverReach global attribute ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attribute Limits

**Slug:** `CLEVERREACH_GET_ATTRIBUTE_LIMITS`

Show the attribute limits applied to the connected CleverReach account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Blacklist Entry

**Slug:** `CLEVERREACH_GET_BLACKLIST_ENTRY`

Check whether an exact email address is on the account-wide CleverReach blacklist and return its blacklist details when present.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Exact email address to check on the account-wide blacklist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Filter

**Slug:** `CLEVERREACH_GET_FILTER`

Get one CleverReach group filter or segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Group ID |
| `filter_id` | string | Yes | Filter ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Filter Metrics

**Slug:** `CLEVERREACH_GET_FILTER_METRICS`

Return statistics or a receiver count for one CleverReach group filter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metric` | string ("stats" | "count") | No | Metric to return: stats or count. |
| `group_id` | string | Yes | Group ID |
| `filter_id` | string | Yes | Filter ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form

**Slug:** `CLEVERREACH_GET_FORM`

Return one legacy CleverReach form by ID. This provider endpoint is deprecated; use CleverReach Flow for new development and migrations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_id` | string | Yes | Legacy CleverReach form ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form Embed Code

**Slug:** `CLEVERREACH_GET_FORM_EMBED_CODE`

Return embeddable HTML, JavaScript, and CSS for an existing legacy CleverReach form, with optional branding controls. This provider endpoint is deprecated; use CleverReach Flow for new development and migrations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_id` | string | Yes | Legacy CleverReach form ID. |
| `embedded` | boolean | No | Whether to return the embedded form variant. |
| `include_css` | boolean | No | Whether to include the CSS portion of the embed code. |
| `include_badge` | boolean | No | Whether to include CleverReach branding; disabling it may require a paid plan. |
| `include_javascript` | boolean | No | Whether to include the JavaScript portion of the embed code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group

**Slug:** `CLEVERREACH_GET_GROUP`

Return one receiver group by its CleverReach group ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | CleverReach group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Stats

**Slug:** `CLEVERREACH_GET_GROUP_STATS`

Return either standard or advanced CleverReach statistics for one receiver group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | CleverReach receiver group ID. |
| `stats_mode` | string ("standard" | "advanced") | No | Statistics view: standard group counts or advanced extended statistics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mailing

**Slug:** `CLEVERREACH_GET_MAILING`

Return one CleverReach mailing campaign by its mailing ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailing_id` | string | Yes | CleverReach mailing ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mailing Channel

**Slug:** `CLEVERREACH_GET_MAILING_CHANNEL`

Return one CleverReach mailing channel or category by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | CleverReach mailing channel or category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get My Content

**Slug:** `CLEVERREACH_GET_MY_CONTENT`

Return one CleverReach "My Content" item by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content_id` | string | Yes | CleverReach "My Content" item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Mailing Receiver

**Slug:** `CLEVERREACH_GET_RANDOM_MAILING_RECEIVER`

Return a random receiver from a CleverReach mailing audience for preview purposes. This does not send the mailing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailing_id` | string | Yes | CleverReach mailing ID whose audience supplies the preview receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Receiver

**Slug:** `CLEVERREACH_GET_RECEIVER`

Return one receiver by ID or exact email address. Supply group_id for group-specific attributes; without it, group-specific information is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | No | Optional group ID for group-specific receiver information. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Receiver Attributes

**Slug:** `CLEVERREACH_GET_RECEIVER_ATTRIBUTES`

Get attribute values for a CleverReach receiver, optionally in one group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | No | Group ID (optional) |
| `receiver_id_or_email` | string | Yes | ID or email of receiver |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Receiver Tags

**Slug:** `CLEVERREACH_GET_RECEIVER_TAGS`

Return all tags currently set on one receiver, optionally filtered by origin.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `origin` | string | No | Tag origin to filter by. Use '*' for any origin. |
| `receiver_id_or_email` | string | Yes | ID or exact email address of the receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report

**Slug:** `CLEVERREACH_GET_REPORT`

Return one mailing report by report or mailing ID, including split-test versions when present.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | CleverReach report ID or mailing ID. For a split test, use the parent report ID rather than a version ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Stats

**Slug:** `CLEVERREACH_GET_REPORT_STATS`

Return one selected statistics view for a mailing report, such as links, countries, clients, traffic, or daily activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | End Unix timestamp; allowed only for daily mode and requires start. |
| `mode` | string ("full" | "clients" | "mediaclients" | "countries" | "quality" | "firsthours" | "traffic" | "daily" | "links" | "conversion" | "custom") | No | Statistics view to return. |
| `start` | integer | No | Start Unix timestamp; allowed only for daily mode and requires end. |
| `report_id` | string | Yes | CleverReach report or mailing ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Attributes

**Slug:** `CLEVERREACH_LIST_ATTRIBUTES`

Return a locally bounded set of global attributes or local attributes for one CleverReach group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `group_id` | string | No | ID of the group; omit to return global attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blacklist Entries

**Slug:** `CLEVERREACH_LIST_BLACKLIST_ENTRIES`

Return a locally bounded set of entries on the global CleverReach blacklist, or on a specific group blacklist when group_id is supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `group_id` | string | No | Optional group ID whose blacklist entries should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bounced Receivers

**Slug:** `CLEVERREACH_LIST_BOUNCED_RECEIVERS`

Return one bounded page of receivers with a bounce date and an opaque cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum bounced receivers in this page. Defaults to 10. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; pass it unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bounces

**Slug:** `CLEVERREACH_LIST_BOUNCES`

Return one page of up to 500 account-wide CleverReach bounce records. Follow next_cursor until an empty terminal page returns no cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum bounces to return in this page (1-500). Defaults to 10. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Filter Receivers

**Slug:** `CLEVERREACH_LIST_FILTER_RECEIVERS`

Return one bounded page of receivers matching a saved CleverReach filter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | No | Receiver email addresses to include. |
| `group_id` | string | Yes | Group ID |
| `order_by` | string | No | field to order by, append 'asc' or 'desc' with a space |
| `filter_id` | string | Yes | Filter ID |
| `page_size` | integer | No | Maximum receivers in this page (1-5000). Defaults to 10. |
| `next_cursor` | string | No | Opaque continuation cursor; omit for the first page. |
| `receiver_ids` | array | No | Receiver IDs to include. |
| `receiver_type` | string ("all" | "active" | "inactive" | "bounce") | No | Receiver subscription state to include. |
| `include_details` | array | No | Additional receiver data to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Filters

**Slug:** `CLEVERREACH_LIST_FILTERS`

Return a locally bounded set of CleverReach filters or segments for one receiver group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `group_id` | string | Yes | Group ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Forms

**Slug:** `CLEVERREACH_LIST_FORMS`

Return a locally bounded set of legacy CleverReach forms globally or for a supplied group. CleverReach marks both REST routes deprecated in favor of Flow, which is outside this toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `group_id` | string | No | Optional group ID whose legacy forms should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups

**Slug:** `CLEVERREACH_LIST_GROUPS`

Return a locally bounded set of receiver groups (lists) in the connected CleverReach account, optionally ordered by creation or change time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `order` | string ("created ASC" | "created DESC" | "changed ASC" | "changed DESC") | No | Optional group ordering by creation or change time and direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Mailing Channels

**Slug:** `CLEVERREACH_LIST_MAILING_CHANNELS`

Return a locally bounded set of CleverReach mailing channels, also called categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Mailing Links

**Slug:** `CLEVERREACH_LIST_MAILING_LINKS`

Return the links CleverReach recorded for one mailing. List-shaped responses are locally bounded; provider summary objects and legacy strings are preserved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `mailing_id` | string | Yes | CleverReach mailing ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Mailing Orders

**Slug:** `CLEVERREACH_LIST_MAILING_ORDERS`

Return a locally bounded set of orders attributed to a CleverReach report or mailing. CleverReach documents no pagination for this endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `mailing_id` | string | Yes | CleverReach report or mailing ID whose attributed orders to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Mailings

**Slug:** `CLEVERREACH_LIST_MAILINGS`

Return campaigns filtered by delivery state, channel, or the state's time window. State 'all' returns one provider-bounded result; specific states return one page with a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | End Unix timestamp. Its time field follows the selected mailing state in the same way as start. |
| `limit` | integer | No | Maximum campaigns to return. The limit is 1-1000 for state 'all' and 1-100 for every specific state. |
| `start` | integer | No | Start Unix timestamp. It filters finish time for finished mailings, creation time for drafts, scheduled send time for waiting mailings, and start time for running mailings. |
| `state` | string ("all" | "finished" | "draft" | "waiting" | "running" | "automation") | No | Campaign delivery state to include. |
| `omit_body` | boolean | No | Set true to leave body_html and body_text empty when only mailing metadata is needed. Omit to use CleverReach's default response. |
| `channel_id` | string | No | Only return mailings in this channel or category ID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Use it only with a state other than 'all'; omit it for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Mailing Templates

**Slug:** `CLEVERREACH_LIST_MAILING_TEMPLATES`

Return locally bounded categories and either agency-managed or user-owned CleverReach templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `owner` | string ("agency" | "user") | Yes | Template owner: agency-managed templates or this user's templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List My Content

**Slug:** `CLEVERREACH_LIST_MY_CONTENT`

Return a locally bounded set of reusable CleverReach "My Content" items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receiver Events

**Slug:** `CLEVERREACH_LIST_RECEIVER_EVENTS`

Return a locally bounded set of events recorded for one CleverReach receiver, either account-wide or in a specific group. CleverReach documents no pagination for this endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `group_id` | string | No | Group ID for group-specific events. Omit it to use the account-level receiver route. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address whose events to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receiver Groups

**Slug:** `CLEVERREACH_LIST_RECEIVER_GROUPS`

Return a locally bounded set of group IDs to which a receiver is allocated, filtered by membership state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `state` | string ("all" | "active" | "inactive") | No | Receiver state within groups to include. |
| `receiver_id_or_email` | string | Yes | ID or exact email address of the receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receiver Orders

**Slug:** `CLEVERREACH_LIST_RECEIVER_ORDERS`

Return a locally bounded set of orders recorded for one CleverReach receiver, globally or in a specific group. CleverReach documents no pagination for this endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `group_id` | string | No | Group ID for group-specific orders; omit for global orders. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address whose orders to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receivers

**Slug:** `CLEVERREACH_LIST_RECEIVERS`

Return one page of receivers in a CleverReach group, optionally filtered by subscription state, email addresses, or receiver IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | No | Receiver email addresses to include. |
| `group_id` | string | Yes | CleverReach group ID whose receivers to list. |
| `order_by` | string | No | Provider field and direction, for example 'email asc' or 'email desc'. |
| `page_size` | integer | No | Maximum receivers in this page (1-5000). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; pass it unchanged. |
| `receiver_ids` | array | No | Receiver IDs to include. |
| `receiver_type` | string ("all" | "active" | "inactive" | "bounce") | No | Receiver subscription state to include. |
| `include_details` | array | No | Additional receiver data to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receiver Tags

**Slug:** `CLEVERREACH_LIST_RECEIVER_TAGS`

Return a locally bounded set of receiver tags already used in the account, optionally filtered by origin.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `origin` | string | No | Tag origin to filter by. Use '*' for any origin or omit for tags without an origin. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Report Receivers

**Slug:** `CLEVERREACH_LIST_REPORT_RECEIVERS`

Return one page of receivers in a report for a delivery or engagement state such as opened, clicked, bounced, or unsubscribed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string ("sent" | "opened" | "clicked" | "notopened" | "notclicked" | "bounced" | "unsubscribed") | Yes | Delivery or engagement state to list: sent, opened, clicked, notopened, notclicked, bounced, or unsubscribed. |
| `link_id` | string | No | For clicked state, restrict results to this link ID. |
| `page_size` | integer | No | Maximum receivers in this page. |
| `report_id` | string | Yes | CleverReach report or mailing ID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit it for the first page and pass it back unchanged to continue. |
| `to_timestamp` | integer | No | Latest matching event Unix timestamp. |
| `from_timestamp` | integer | No | Earliest matching event Unix timestamp. |
| `include_details` | array | No | Additional receiver data to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Reports

**Slug:** `CLEVERREACH_LIST_REPORTS`

Return one page of mailing reports filtered by date range, group, or channel. detail_level controls the richness of each report, not which reports match.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | End Unix timestamp; must be supplied together with start. |
| `start` | integer | No | Start Unix timestamp; must be supplied together with end. |
| `group_id` | string | No | Only return reports for this receiver group ID. |
| `page_size` | integer | No | Maximum reports in this page. |
| `channel_id` | string | No | Only return reports for this channel or category ID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit it for the first page and pass it back unchanged to continue. |
| `detail_level` | string ("full" | "basic") | No | Richness of each returned report: full includes more report data and basic returns a reduced representation. This does not filter which reports are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `CLEVERREACH_LIST_TAGS`

Return one page of account tags or the account's supertags. Regular tags support group, origin, ordering, page_size, and a bounded continuation cursor. The limit field locally caps only list-shaped supertags and does not reduce provider API usage; a legacy string response is preserved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return (1-100). Defaults to 10. Applied locally after CleverReach returns the complete unpaginated response; it does not reduce provider API usage. |
| `origin` | string | No | Regular-tag origin filter. Omit for tags without an origin or use '*' for any origin. |
| `group_id` | string | No | Group ID to filter by. |
| `order_by` | string ("tag" | "origin" | "count") | No | Field by which to order regular tags. |
| `tag_type` | string ("regular" | "super") | No | Return regular tags or CleverReach supertags. |
| `get_count` | boolean | No | For supertags, include each tag/source count. |
| `page_size` | integer | No | Maximum regular tags in this page. Defaults to 10. |
| `next_cursor` | string | No | Opaque regular-tag continuation cursor; pass it unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Receiver From Group

**Slug:** `CLEVERREACH_REMOVE_RECEIVER_FROM_GROUP`

Remove one exact receiver from one specified group. This does not claim to delete the receiver account-wide or remove it from any other group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Exact ID of the group from which to remove the receiver. |
| `receiver_id_or_email` | string | Yes | Exact receiver ID or email address to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Receivers From Group

**Slug:** `CLEVERREACH_REMOVE_RECEIVERS_FROM_GROUP`

Remove a non-empty explicit list of exact receivers from one specified group. This does not claim to delete them account-wide or remove them from other groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Exact ID of the group from which to remove the receivers. |
| `receivers` | array | Yes | Non-empty list of exact receiver IDs or email addresses to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Receiver Tags

**Slug:** `CLEVERREACH_REMOVE_RECEIVER_TAGS`

Remove specified tags from one receiver. An origin wildcard such as 'shop.*' removes every receiver tag from that origin.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to remove. Use 'origin.*' to remove all tags for that origin. |
| `receiver_id_or_email` | string | Yes | ID or exact email address of the receiver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Mailing Preview

**Slug:** `CLEVERREACH_SEND_MAILING_PREVIEW`

Immediately deliver a preview email for one mailing to the specified CleverReach account-user addresses. This sends real email and cannot be undone, but it does not launch the mailing campaign to its audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receivers` | array | Yes | One or more CleverReach account-user email addresses that will immediately receive the preview email. |
| `mailing_id` | string | Yes | CleverReach mailing ID whose preview will be delivered. |
| `preview_text` | string | No | Text appended to the preview email's subject line. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Receiver Attribute

**Slug:** `CLEVERREACH_SET_RECEIVER_ATTRIBUTE`

Update one attribute value on a CleverReach receiver at account or group scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | Value |
| `group_id` | string | No | Group ID; omit for the account-level route. |
| `attribute_id` | string | Yes | Attribute ID |
| `receiver_id_or_email` | string | Yes | ID or Email address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Receiver Status

**Slug:** `CLEVERREACH_SET_RECEIVER_STATUS`

Activate or deactivate one receiver in a CleverReach group, changing whether the subscriber is active for mailings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "inactive") | Yes | Subscription status to set for the receiver. |
| `group_id` | string | Yes | CleverReach group ID containing the receiver. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Attribute

**Slug:** `CLEVERREACH_UPDATE_ATTRIBUTE`

Update a CleverReach global or group-local attribute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("text" | "number" | "gender" | "date") | No | Type of data (text|number|gender|date) |
| `group_id` | string | No | group id; omit to update a global attribute. |
| `description` | string | No | Replacement human-readable explanation of the receiver data stored in this attribute. |
| `attribute_id` | string | Yes | Exact CleverReach attribute ID to update. |
| `preview_value` | string | No | Replacement example value shown when previewing the attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blacklist Entry

**Slug:** `CLEVERREACH_UPDATE_BLACKLIST_ENTRY`

Update the comment on one account-wide CleverReach blacklist entry, identified by its email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the account-wide blacklist entry to update. |
| `comment` | string | Yes | Replacement note for the blacklist entry. Use an empty string to clear it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Filter

**Slug:** `CLEVERREACH_UPDATE_FILTER`

Update a CleverReach filter or segment in one receiver group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the filter or segment. |
| `rules` | array | No | Replacement CleverReach filter rule objects. |
| `group_id` | string | Yes | group ID |
| `operator` | string ("AND" | "OR") | No | default operator to use |
| `filter_id` | string | Yes | filter ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group

**Slug:** `CLEVERREACH_UPDATE_GROUP`

Update the name, notes, lock setting, or backup setting of an existing CleverReach receiver group. Provide at least one of name, receiver_info, locked, or backup. Only explicitly supplied non-null fields are sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New group name. Omit to leave the name unchanged. |
| `backup` | boolean | No | Whether CleverReach should back up the group. Omit to leave this setting unchanged. |
| `locked` | boolean | No | Whether to protect the group from deletion. Omit to leave this setting unchanged. |
| `group_id` | string | Yes | CleverReach group ID to update. |
| `receiver_info` | string | No | New notes describing the group's receivers. Omit to leave the notes unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Mailing

**Slug:** `CLEVERREACH_UPDATE_MAILING`

Update the content, audience, sender, tracking settings, or tags of an existing CleverReach mailing campaign without sending it. Provide at least one of name, subject, sender_name, sender_email, content, receivers, settings, or tags. Only explicitly supplied non-null fields are sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New internal campaign name. Omit to leave it unchanged. |
| `tags` | array | No | Replacement mailing tags. Supply an empty list to clear all tags. |
| `content` | object | No | Replacement mailing content. Omit to leave the content unchanged. |
| `subject` | string | No | New email subject line. Omit to leave it unchanged. |
| `settings` | object | No | Campaign settings to update. Only supplied non-null settings are sent. |
| `receivers` | object | No | Replacement campaign audience. Omit to leave the audience unchanged. |
| `mailing_id` | string | Yes | CleverReach mailing ID to update. |
| `sender_name` | string | No | New sender display name. Omit to leave it unchanged. |
| `sender_email` | string | No | New sender email address. Omit to leave it unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update My Content

**Slug:** `CLEVERREACH_UPDATE_MY_CONTENT`

Update supplied fields of one CleverReach "My Content" item. Omitted fields are not sent; provide at least one non-null field to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Replacement content URL when supplied. |
| `cors` | boolean | No | Replacement cross-origin access flag when supplied. |
| `icon` | string | No | Replacement provider icon name when supplied. |
| `name` | string | No | Replacement item name when supplied. |
| `type` | string ("none" | "default" | "product" | "content" | "blog") | No | Replacement provider content type when supplied. |
| `content_id` | string | Yes | CleverReach "My Content" item ID. |
| `content_access_code` | string | No | Replacement access code CleverReach sends when loading the content URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Receiver

**Slug:** `CLEVERREACH_UPDATE_RECEIVER`

Update lifecycle timestamps, profile attributes, tags, or orders for one receiver in a CleverReach group without changing the email. Provide at least one receiver field to update. Source is creation-only: CleverReach preserves the original source for an existing receiver.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Complete receiver tag values to send in the update. Send an empty list to clear tags. |
| `orders` | array | No | Orders to record while updating the receiver. |
| `source` | string | No | Receiver source or origin. CleverReach only sets source when a receiver is created and preserves the original source on existing receivers. |
| `group_id` | string | Yes | CleverReach group ID containing the receiver. |
| `activated` | string | No | Unix activation timestamp for immediate activation. Supplying it bypasses later double-opt-in activation; omit it when intentionally leaving a receiver pending double opt in. Omitting all three lifecycle timestamps activates a new receiver. |
| `attributes` | object | No | Group-local attribute values to set, keyed by attribute name. |
| `registered` | string | No | Unix registration timestamp. For a new receiver, if registered, activated, and deactivated are all omitted, CleverReach sets registration and activation to the current time. |
| `deactivated` | string | No | Unix deactivation timestamp. A nonzero value makes the receiver inactive; zero can reactivate it during update or upsert. Omit unless deliberately changing activation state. |
| `global_attributes` | object | No | Global attribute values to set, keyed by attribute name. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Receiver Order

**Slug:** `CLEVERREACH_UPDATE_RECEIVER_ORDER`

IRREVERSIBLE MUTATION: replace the documented details of one CleverReach order item by its internal id from LIST_RECEIVER_ORDERS, not by the caller-defined order_id. CleverReach provides no revision history or automatic rollback.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | number | No | Single-product price. |
| `stamp` | integer | No | Unix order timestamp. |
| `source` | string | No | Shop or source name. |
| `product` | string | Yes | Replacement product name. |
| `currency` | string | No | Currency code. |
| `group_id` | string | No | Group ID for a group-specific order; omit for a global order. |
| `quantity` | integer | No | Quantity bought. |
| `mailing_id` | string | No | Mailing ID for conversion tracking. |
| `product_id` | string | No | Your product ID. |
| `internal_order_id` | string | Yes | CleverReach internal order item ID from the id field returned by LIST_RECEIVER_ORDERS. This is not the caller-defined order_id. The legacy order_id parameter name remains accepted for compatibility. |
| `receiver_id_or_email` | string | Yes | Receiver ID or exact email address that owns the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Blacklist Emails

**Slug:** `CLEVERREACH_VALIDATE_BLACKLIST_EMAILS`

Filter up to 1000 email addresses against the global or group CleverReach blacklist without changing blacklist state. By default the result contains addresses that are not blacklisted; set invert=true to return blacklisted addresses instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Up to 1000 email addresses to filter. |
| `invert` | boolean | No | Set true to return blacklisted addresses instead of the default non-blacklisted addresses. |
| `group_id` | string | No | Optional receiver group ID; omit to use the global blacklist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Receiver Emails

**Slug:** `CLEVERREACH_VALIDATE_RECEIVER_EMAILS`

Submit up to 1000 email addresses and return CleverReach's valid-address result. The check excludes blacklisted addresses; group_id also requires active membership, and invert returns invalid addresses instead. This read-like POST changes no data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Up to 1000 email addresses to check against the blacklist and, when group_id is set, active group membership. |
| `invert` | boolean | No | Return invalid addresses instead of valid addresses. |
| `group_id` | string | No | Group ID for an additional active-state check; omit for global results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |