Skip to main content
CleverReach logo
  • Category: marketing automation
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 87
  • Triggers: 0
  • Slug: CLEVERREACH
  • Version: 20261101_00

Tools

Slug: CLEVERREACH_ADD_BLACKLIST_ENTRIESAdd email addresses to the account-wide CleverReach blacklist in one provider batch request.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_ADD_BLACKLIST_ENTRYAdd 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

string
required
Email address to suppress globally or in the supplied group.
string
Optional reason or note for a global blacklist entry. Group-specific blacklist entries do not support comments.
string
Optional group ID for a group-specific blacklist entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_ADD_GROUP_RECEIVER_TAGSIRREVERSIBLE 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

array
required
Tags to add. Prefix an origin followed by a period, for example ‘batman.Good’.
string
required
Group ID whose receiver tags to update. Using this group-specific route can trigger irreversible THEA automation.
string
required
ID or exact email address of the receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_ADD_RECEIVER_TAGSAdd 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

array
required
Tags to add. Prefix an origin followed by a period, for example ‘batman.Good’.
string
required
ID or exact email address of the receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_BULK_UPDATE_RECEIVERSUpdate 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

string ("standard" | "plus")
Use ‘plus’ to apply +/- numeric attribute changes and ‘-tag’ or ‘-origin.*’ tag removals; standard replaces supplied values.
string
required
Group ID.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_BULK_UPSERT_RECEIVERSCreate 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

string ("standard" | "plus")
Use ‘plus’ to apply +/- numeric attribute changes and ‘-tag’ or ‘-origin.*’ tag removals; standard replaces supplied values.
string
required
Group ID.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CHANGE_RECEIVER_EMAILChange 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

string
required
New receiver email address.
boolean
Whether to overwrite a receiver that already has the new email. Enabling this can replace existing receiver data.
string
required
Numeric ID or exact current email address of the receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CLONE_RECEIVERCopy 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

string
required
Email address for the cloned receiver.
boolean
Whether to overwrite an existing receiver with the target email. Enabling this can replace existing receiver data.
string
required
ID of the group to assign the cloned receiver to.
string
required
ID or exact email address of the receiver to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_COUNT_RECEIVERS_BY_TAGSCount 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_ATTRIBUTECreate a global or group-local CleverReach receiver attribute.

Input Parameters

string
required
name for internal use
string ("text" | "number" | "gender" | "date")
required
type of data (text|number|gender|date)
string
ID of group; omit to create a global attribute.
string
Human-readable explanation of the receiver data stored in this attribute.
string
Value CleverReach uses when a receiver has no explicit value for this attribute.
string
Example value shown in CleverReach when previewing the attribute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_FILTERCreate a reusable CleverReach filter or segment in one receiver group.

Input Parameters

string
required
Name of the reusable filter or segment.
array
required
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.
string
required
group ID
string ("AND" | "OR")
Operator used to combine all rules: AND requires every rule; OR requires any rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_GROUPCreate a CleverReach receiver group and return its group ID for subsequent subscriber operations.

Input Parameters

string
required
Name of the receiver group.
boolean
Whether CleverReach should back up the group.
boolean
Whether to protect the group from deletion.
string
Optional notes describing the receivers in this group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_MAILINGCreate a CleverReach mailing campaign definition. This action does not send the campaign, and CleverReach may confirm creation without returning its ID.

Input Parameters

string
required
Internal campaign name.
array
Tags for the mailing.
object
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.
string
required
Email subject line.
object
Optional settings object with editor, open_tracking, click_tracking, link_tracking_url/type, google_campaign_name, unsubscribe_form_id, and category_id.
object
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.
string
required
Sender display name.
string
required
Sender email address configured for the CleverReach account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_MAILING_TEMPLATECreate a reusable CleverReach mailing template. CleverReach exposes no matching template-delete operation, so this creation is not reversible through this toolkit.

Input Parameters

string
required
Complete HTML code of the template.
string
required
Internal name of the template.
array
Optional tags for the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_MY_CONTENTCreate 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

string
required
URL loaded by the reusable content item.
boolean
Whether cross-origin access is enabled.
string
Optional provider icon name.
string
required
Name of the “My Content” item.
string ("none" | "default" | "product" | "content" | "blog")
Optional provider content type.
string
Optional access code CleverReach sends when loading the content URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_RECEIVERCreate 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

array
Tags to assign to the receiver.
string
required
Subscriber email address.
array
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.
string
Origin of the subscriber record, such as website signup.
string
required
CleverReach group ID in which to create the receiver.
string
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.
object
Group-local attribute values keyed by attribute name.
string
Unix registration timestamp. For a new receiver, if registered, activated, and deactivated are all omitted, CleverReach sets registration and activation to the current time.
string
Unix deactivation timestamp. A nonzero value makes the receiver inactive; zero can reactivate it during update or upsert. Omit unless deliberately changing activation state.
object
Global attribute values keyed by attribute name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_RECEIVER_EVENTIRREVERSIBLE: permanently add an event to one CleverReach receiver. CleverReach provides no event deletion endpoint, so this action cannot undo or remove it.

Input Parameters

string
Event log type. CleverReach documents ‘log’ as the default.
string
required
Log data or text to record permanently.
string
Group ID for a group-specific event route; omit for the account-level route.
string
required
Receiver ID that will permanently receive the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_RECEIVER_ORDERMUTATES 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

number
Single-product price; CleverReach documents 0 as the default.
integer
Unix order timestamp. CleverReach uses the current time when omitted.
string
Shop or source name.
string
required
Product name.
string
Currency code; CleverReach documents EUR as the default.
string
Group ID for a group-specific order; omit for a global order.
string
required
Your order ID.
integer
Quantity bought; CleverReach documents 1 as the default.
string
Mailing ID for conversion tracking.
string
Your product ID.
string
required
Receiver ID or exact email address that will receive the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_CREATE_RECEIVERSCreate up to 50 subscribers in one CleverReach group with optional attributes, tags and order history; the non-atomic batch returns per-receiver outcomes, including any not attempted after a batch-wide failure. When lifecycle timestamps are omitted, CleverReach activates receivers without double opt-in mail, though results may briefly show inactive.

Input Parameters

string
required
CleverReach group ID in which to create the receivers.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_ATTRIBUTEPermanently 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

string
Group ID; omit to delete a global attribute.
string
required
Exact CleverReach attribute ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_BLACKLIST_ENTRIESPermanently 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

array
required
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_BLACKLIST_ENTRYPermanently remove one email address from the global CleverReach blacklist, or from a group blacklist when group_id is supplied.

Input Parameters

string
required
Exact email address to remove from the account-wide blacklist.
string
Optional group ID for a group-specific blacklist entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_FILTERPermanently 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

string
required
group ID
string
required
filter ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_GROUPPermanently delete one CleverReach receiver group by ID. This operation cannot be undone, and CleverReach may reject deletion of a locked group.

Input Parameters

string
required
CleverReach group ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_MAILING_CHANNELPermanently 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

string
required
Exact CleverReach channel/category ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_MY_CONTENTPermanently 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

string
required
Exact CleverReach “My Content” item ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_RECEIVER_ACCOUNT_WIDEPermanently delete one exact receiver at account level. This broader operation can remove the receiver from every group and cannot be undone.

Input Parameters

string
required
Exact receiver ID or email address to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_RECEIVER_ORDERIRREVERSIBLE: 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

string
Group ID for a group-specific order; omit for a global order.
string
required
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.
string
required
Receiver ID or exact email address that owns the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_RECEIVERS_ACCOUNT_WIDEPermanently 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

array
required
Non-empty list of exact receiver IDs or email addresses to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_DELETE_REPORTPermanently 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

string
required
Exact CleverReach report or mailing ID to permanently delete.
boolean
required
Must be true to confirm irreversible deletion of the report analytics and disabling of all report links, including unsubscribe links.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_FILTER_RECEIVERSReturn one bounded page of receivers matching temporary CleverReach filter rules.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_ATTRIBUTEReturn one CleverReach global attribute by ID.

Input Parameters

string
required
CleverReach global attribute ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_ATTRIBUTE_LIMITSShow the attribute limits applied to the connected CleverReach account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_BLACKLIST_ENTRYCheck whether an exact email address is on the account-wide CleverReach blacklist and return its blacklist details when present.

Input Parameters

string
required
Exact email address to check on the account-wide blacklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_FILTERGet one CleverReach group filter or segment.

Input Parameters

string
required
Group ID
string
required
Filter ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_FILTER_METRICSReturn statistics or a receiver count for one CleverReach group filter.

Input Parameters

string ("stats" | "count")
Metric to return: stats or count.
string
required
Group ID
string
required
Filter ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_FORMReturn one legacy CleverReach form by ID. This provider endpoint is deprecated; use CleverReach Flow for new development and migrations.

Input Parameters

string
required
Legacy CleverReach form ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_FORM_EMBED_CODEReturn 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

string
required
Legacy CleverReach form ID.
boolean
Whether to return the embedded form variant.
boolean
Whether to include the CSS portion of the embed code.
boolean
Whether to include CleverReach branding; disabling it may require a paid plan.
boolean
Whether to include the JavaScript portion of the embed code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_GROUPReturn one receiver group by its CleverReach group ID.

Input Parameters

string
required
CleverReach group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_GROUP_STATSReturn either standard or advanced CleverReach statistics for one receiver group.

Input Parameters

string
required
CleverReach receiver group ID.
string ("standard" | "advanced")
Statistics view: standard group counts or advanced extended statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_MAILINGReturn one CleverReach mailing campaign by its mailing ID.

Input Parameters

string
required
CleverReach mailing ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_MAILING_CHANNELReturn one CleverReach mailing channel or category by ID.

Input Parameters

string
required
CleverReach mailing channel or category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_MY_CONTENTReturn one CleverReach “My Content” item by ID.

Input Parameters

string
required
CleverReach “My Content” item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_RANDOM_MAILING_RECEIVERReturn a random receiver from a CleverReach mailing audience for preview purposes. This does not send the mailing.

Input Parameters

string
required
CleverReach mailing ID whose audience supplies the preview receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_RECEIVERReturn one receiver by ID or exact email address. Supply group_id for group-specific attributes; without it, group-specific information is empty.

Input Parameters

string
Optional group ID for group-specific receiver information.
string
required
Receiver ID or exact email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_RECEIVER_ATTRIBUTESGet attribute values for a CleverReach receiver, optionally in one group.

Input Parameters

string
Group ID (optional)
string
required
ID or email of receiver

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_RECEIVER_TAGSReturn all tags currently set on one receiver, optionally filtered by origin.

Input Parameters

string
Tag origin to filter by. Use ’*’ for any origin.
string
required
ID or exact email address of the receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_REPORTReturn one mailing report by report or mailing ID, including split-test versions when present.

Input Parameters

string
required
CleverReach report ID or mailing ID. For a split test, use the parent report ID rather than a version ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_GET_REPORT_STATSReturn one selected statistics view for a mailing report, such as links, countries, clients, traffic, or daily activity.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_ATTRIBUTESReturn a locally bounded set of global attributes or local attributes for one CleverReach group.

Input Parameters

integer
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.
string
ID of the group; omit to return global attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_BLACKLIST_ENTRIESReturn a locally bounded set of entries on the global CleverReach blacklist, or on a specific group blacklist when group_id is supplied.

Input Parameters

integer
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.
string
Optional group ID whose blacklist entries should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_BOUNCED_RECEIVERSReturn one bounded page of receivers with a bounce date and an opaque cursor for the next page.

Input Parameters

integer
Maximum bounced receivers in this page. Defaults to 10.
string
Opaque continuation cursor from a previous response; pass it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_BOUNCESReturn one page of up to 500 account-wide CleverReach bounce records. Follow next_cursor until an empty terminal page returns no cursor.

Input Parameters

integer
Maximum bounces to return in this page (1-500). Defaults to 10.
string
Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_FILTER_RECEIVERSReturn one bounded page of receivers matching a saved CleverReach filter.

Input Parameters

array
Receiver email addresses to include.
string
required
Group ID
string
field to order by, append ‘asc’ or ‘desc’ with a space
string
required
Filter ID
integer
Maximum receivers in this page (1-5000). Defaults to 10.
string
Opaque continuation cursor; omit for the first page.
array
Receiver IDs to include.
string ("all" | "active" | "inactive" | "bounce")
Receiver subscription state to include.
array
Additional receiver data to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_FILTERSReturn a locally bounded set of CleverReach filters or segments for one receiver group.

Input Parameters

integer
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.
string
required
Group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_FORMSReturn 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

integer
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.
string
Optional group ID whose legacy forms should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_GROUPSReturn a locally bounded set of receiver groups (lists) in the connected CleverReach account, optionally ordered by creation or change time.

Input Parameters

integer
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.
string ("created ASC" | "created DESC" | "changed ASC" | "changed DESC")
Optional group ordering by creation or change time and direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_MAILING_CHANNELSReturn a locally bounded set of CleverReach mailing channels, also called categories.

Input Parameters

integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_MAILING_ORDERSReturn a locally bounded set of orders attributed to a CleverReach report or mailing. CleverReach documents no pagination for this endpoint.

Input Parameters

integer
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.
string
required
CleverReach report or mailing ID whose attributed orders to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_MAILINGSReturn 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

integer
End Unix timestamp. Its time field follows the selected mailing state in the same way as start.
integer
Maximum campaigns to return. The limit is 1-1000 for state ‘all’ and 1-100 for every specific state.
integer
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.
string ("all" | "finished" | "draft" | "waiting" | "running" | "automation")
Campaign delivery state to include.
boolean
Set true to leave body_html and body_text empty when only mailing metadata is needed. Omit to use CleverReach’s default response.
string
Only return mailings in this channel or category ID.
string
Opaque continuation cursor returned by a previous call. Use it only with a state other than ‘all’; omit it for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_MAILING_TEMPLATESReturn locally bounded categories and either agency-managed or user-owned CleverReach templates.

Input Parameters

integer
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.
string ("agency" | "user")
required
Template owner: agency-managed templates or this user’s templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_MY_CONTENTReturn a locally bounded set of reusable CleverReach “My Content” items.

Input Parameters

integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_RECEIVER_EVENTSReturn 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

integer
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.
string
Group ID for group-specific events. Omit it to use the account-level receiver route.
string
required
Receiver ID or exact email address whose events to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_RECEIVER_GROUPSReturn a locally bounded set of group IDs to which a receiver is allocated, filtered by membership state.

Input Parameters

integer
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.
string ("all" | "active" | "inactive")
Receiver state within groups to include.
string
required
ID or exact email address of the receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_RECEIVER_ORDERSReturn 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

integer
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.
string
Group ID for group-specific orders; omit for global orders.
string
required
Receiver ID or exact email address whose orders to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_RECEIVERSReturn one page of receivers in a CleverReach group, optionally filtered by subscription state, email addresses, or receiver IDs.

Input Parameters

array
Receiver email addresses to include.
string
required
CleverReach group ID whose receivers to list.
string
Provider field and direction, for example ‘email asc’ or ‘email desc’.
integer
Maximum receivers in this page (1-5000).
string
Opaque continuation cursor returned by a previous call; pass it unchanged.
array
Receiver IDs to include.
string ("all" | "active" | "inactive" | "bounce")
Receiver subscription state to include.
array
Additional receiver data to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_RECEIVER_TAGSReturn a locally bounded set of receiver tags already used in the account, optionally filtered by origin.

Input Parameters

integer
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.
string
Tag origin to filter by. Use ’*’ for any origin or omit for tags without an origin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_REPORT_RECEIVERSReturn one page of receivers in a report for a delivery or engagement state such as opened, clicked, bounced, or unsubscribed.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_REPORTSReturn 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

integer
End Unix timestamp; must be supplied together with start.
integer
Start Unix timestamp; must be supplied together with end.
string
Only return reports for this receiver group ID.
integer
Maximum reports in this page.
string
Only return reports for this channel or category ID.
string
Opaque continuation cursor returned by a previous call. Omit it for the first page and pass it back unchanged to continue.
string ("full" | "basic")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_LIST_TAGSList CleverReach account tags or supertags, optionally filtered by group. Regular tags also support origin filtering, ordering, configurable page size, and a continuation cursor; supertags can include tag and source counts.

Input Parameters

integer
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.
string
Regular-tag origin filter. Omit for tags without an origin or use ’*’ for any origin.
string
Group ID to filter by.
string ("tag" | "origin" | "count")
Field by which to order regular tags.
string ("regular" | "super")
Return regular tags or CleverReach supertags.
boolean
For supertags, include each tag/source count.
integer
Maximum regular tags in this page. Defaults to 10.
string
Opaque regular-tag continuation cursor; pass it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_REMOVE_RECEIVER_FROM_GROUPRemove 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

string
required
Exact ID of the group from which to remove the receiver.
string
required
Exact receiver ID or email address to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_REMOVE_RECEIVERS_FROM_GROUPRemove 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

string
required
Exact ID of the group from which to remove the receivers.
array
required
Non-empty list of exact receiver IDs or email addresses to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_REMOVE_RECEIVER_TAGSRemove specified tags from one receiver. An origin wildcard such as ‘shop.*’ removes every receiver tag from that origin.

Input Parameters

array
required
Tags to remove. Use ‘origin.*’ to remove all tags for that origin.
string
required
ID or exact email address of the receiver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_SEND_MAILING_PREVIEWImmediately 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

array
required
One or more CleverReach account-user email addresses that will immediately receive the preview email.
string
required
CleverReach mailing ID whose preview will be delivered.
string
Text appended to the preview email’s subject line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_SET_RECEIVER_ATTRIBUTEUpdate one attribute value on a CleverReach receiver at account or group scope.

Input Parameters

string
required
Value
string
Group ID; omit for the account-level route.
string
required
Attribute ID
string
required
ID or Email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_SET_RECEIVER_STATUSActivate or deactivate one receiver in a CleverReach group, changing whether the subscriber is active for mailings.

Input Parameters

string ("active" | "inactive")
required
Subscription status to set for the receiver.
string
required
CleverReach group ID containing the receiver.
string
required
Receiver ID or exact email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_ATTRIBUTEUpdate a CleverReach global or group-local attribute.

Input Parameters

string ("text" | "number" | "gender" | "date")
Type of data (text|number|gender|date)
string
group id; omit to update a global attribute.
string
Replacement human-readable explanation of the receiver data stored in this attribute.
string
required
Exact CleverReach attribute ID to update.
string
Replacement example value shown when previewing the attribute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_BLACKLIST_ENTRYUpdate the comment on one account-wide CleverReach blacklist entry, identified by its email address.

Input Parameters

string
required
Email address of the account-wide blacklist entry to update.
string
required
Replacement note for the blacklist entry. Use an empty string to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_FILTERUpdate a CleverReach filter or segment in one receiver group.

Input Parameters

string
New name for the filter or segment.
array
Replacement CleverReach filter rule objects.
string
required
group ID
string ("AND" | "OR")
default operator to use
string
required
filter ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_GROUPUpdate 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

string
New group name. Omit to leave the name unchanged.
boolean
Whether CleverReach should back up the group. Omit to leave this setting unchanged.
boolean
Whether to protect the group from deletion. Omit to leave this setting unchanged.
string
required
CleverReach group ID to update.
string
New notes describing the group’s receivers. Omit to leave the notes unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_MAILINGUpdate 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

string
New internal campaign name. Omit to leave it unchanged.
array
Replacement mailing tags. Supply an empty list to clear all tags.
object
Replacement mailing content. Omit to leave the content unchanged.
string
New email subject line. Omit to leave it unchanged.
object
Campaign settings to update. Only supplied non-null settings are sent.
object
Replacement campaign audience. Omit to leave the audience unchanged.
string
required
CleverReach mailing ID to update.
string
New sender display name. Omit to leave it unchanged.
string
New sender email address. Omit to leave it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_MY_CONTENTUpdate supplied fields of one CleverReach “My Content” item. Omitted fields are not sent; provide at least one non-null field to update.

Input Parameters

string
Replacement content URL when supplied.
boolean
Replacement cross-origin access flag when supplied.
string
Replacement provider icon name when supplied.
string
Replacement item name when supplied.
string ("none" | "default" | "product" | "content" | "blog")
Replacement provider content type when supplied.
string
required
CleverReach “My Content” item ID.
string
Replacement access code CleverReach sends when loading the content URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_RECEIVERUpdate 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

array
Complete receiver tag values to send in the update. Send an empty list to clear tags.
array
Orders to record while updating the receiver.
string
Receiver source or origin. CleverReach only sets source when a receiver is created and preserves the original source on existing receivers.
string
required
CleverReach group ID containing the receiver.
string
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.
object
Group-local attribute values to set, keyed by attribute name.
string
Unix registration timestamp. For a new receiver, if registered, activated, and deactivated are all omitted, CleverReach sets registration and activation to the current time.
string
Unix deactivation timestamp. A nonzero value makes the receiver inactive; zero can reactivate it during update or upsert. Omit unless deliberately changing activation state.
object
Global attribute values to set, keyed by attribute name.
string
required
Receiver ID or exact email address to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_UPDATE_RECEIVER_ORDERIRREVERSIBLE 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

number
Single-product price.
integer
Unix order timestamp.
string
Shop or source name.
string
required
Replacement product name.
string
Currency code.
string
Group ID for a group-specific order; omit for a global order.
integer
Quantity bought.
string
Mailing ID for conversion tracking.
string
Your product ID.
string
required
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.
string
required
Receiver ID or exact email address that owns the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_VALIDATE_BLACKLIST_EMAILSFilter 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

array
required
Up to 1000 email addresses to filter.
boolean
Set true to return blacklisted addresses instead of the default non-blacklisted addresses.
string
Optional receiver group ID; omit to use the global blacklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLEVERREACH_VALIDATE_RECEIVER_EMAILSSubmit 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

array
required
Up to 1000 email addresses to check against the blacklist and, when group_id is set, active group membership.
boolean
Return invalid addresses instead of valid addresses.
string
Group ID for an additional active-state check; omit for global results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not