Skip to main content
AimTell logo
  • Category: notifications
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 15
  • Triggers: 0
  • Slug: AIMTELL
  • Version: 20261101_00

Tools

Slug: AIMTELL_CREATE_MANUAL_CAMPAIGNCreate a manual push campaign as a draft only; this tool never schedules or sends it.

Input Parameters

string
Notification body text for the draft.
Destination URL opened when the notification is clicked.
string
required
Internal campaign name.
string
Notification title for the draft.
integer
required
AimTell website ID that will own the draft.
string
HTTPS URL of a custom notification icon.
integer
Seconds before an undelivered notification expires.
string
HTTPS URL of a custom notification image.
array
Audience segment IDs to target.

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: AIMTELL_CREATE_SEGMENTCreate a named audience segment for a website from an AimTell segment definition.

Input Parameters

string
required
Human-readable segment name.
integer
required
AimTell website ID that will own the segment.
string
required
AimTell segment definition expression; obtain the expected syntax from an existing segment or AimTell documentation.

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: AIMTELL_DELETE_MANUAL_CAMPAIGNPermanently delete one manual campaign by ID. This destructive action cannot be undone and permanently removes the campaign.

Input Parameters

integer
required
Manual campaign 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: AIMTELL_DELETE_SEGMENTPermanently delete one audience segment by ID. This destructive action cannot be undone; it removes the segment but does not delete its subscribers.

Input Parameters

integer
required
Segment 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: AIMTELL_GET_ANALYTICS_OVER_TIMEReturn a daily AimTell metric over a date range for all websites or one website.

Input Parameters

string ("new_subscribers" | "unsubscribes" | "notifications" | "notification_clicks" | "opt_in" | "inactive" | "revenue")
required
Daily AimTell metric to retrieve.
integer
Website ID for a site-specific report; omit to aggregate all websites.
string
required
Last date to include, in YYYY-MM-DD format.
string
required
First date to include, in YYYY-MM-DD format.
boolean
For an all-websites report, include per-site values when AimTell provides them.

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: AIMTELL_GET_CAMPAIGN_RESULTSReturn daily send, delivery, bounce, click, conversion, and available revenue results for a manual, event-triggered, RSS, or welcome campaign.

Input Parameters

string
required
Last date to include in YYYY-MM-DD format.
string
required
First date to include in YYYY-MM-DD format.
integer
required
Campaign ID whose daily results to retrieve.
string ("manual" | "event_triggered" | "rss" | "welcome")
required
Campaign family: manual, event_triggered, rss, or welcome.

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: AIMTELL_LIST_CAMPAIGNSReturn one page of manual, event-triggered, RSS, or API push campaigns for an AimTell website.

Input Parameters

integer
Maximum campaigns to request in this page; AimTell documents no upper bound.
integer
required
AimTell website ID whose campaigns to return.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string ("manual" | "event_triggered" | "rss" | "api_push")
required
Campaign family to list: manual, event_triggered, rss, or api_push.

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: AIMTELL_LIST_NOTIFICATION_LOGSReturn one page from AimTell’s sampled notification log for the last seven days, optionally filtered to one subscriber. This is not a complete delivery ledger and does not include every notification sent to every subscriber.

Input Parameters

integer
Maximum log records to request in this page; AimTell documents no upper bound.
integer
required
AimTell website ID whose sampled notification logs to return.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Optional subscriber UID used to filter the sampled notification logs.

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: AIMTELL_LIST_SEGMENTSReturn all audience segments for an AimTell website, including the IDs and definitions used for subscriber filtering and campaign targeting.

Input Parameters

integer
required
AimTell website ID from AIMTELL_LIST_WEBSITES.

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: AIMTELL_LIST_SUBSCRIBERSReturn one page of subscribers for an AimTell website, optionally filtered by segment or subscriber ID and optionally including attributes or notification history. AimTell may return processing=true with no subscriber page while it prepares the data; retry the same request in that case.

Input Parameters

integer
Maximum subscribers to request in this page.
array
Additional subscriber data to include: attributes, notifications, or both.
integer
required
AimTell website ID from AIMTELL_LIST_WEBSITES.
integer
Return only subscribers belonging to this AimTell segment.
string
Opaque continuation cursor from a previous call; omit for the first page.
string
Return only the subscriber with this AimTell subscriber UID.

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: AIMTELL_LIST_WEBSITESReturn one page of websites available to the connected AimTell account, including site IDs needed by other tools. Use next_cursor to retrieve later pages.

Input Parameters

integer
Maximum websites to return in this page; AimTell documents no upper bound.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
boolean
Whether to request additional website data such as subscriber_count.

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: AIMTELL_SEND_PUSH_NOTIFICATIONSubmit a one-off push notification to exactly one explicitly selected audience: subscriber IDs, one segment, one alias, or the website’s full reachable audience. A successful response means AimTell queued the request, not that it was delivered.

Input Parameters

string
required
Notification body shown to recipients.
Destination URL opened when a recipient clicks the notification.
string
required
Notification title shown to recipients.
integer
required
AimTell website ID that sends the notification.
string
HTTPS URL of a custom notification icon.
integer
Seconds before an undelivered notification expires.
string
HTTPS URL of a custom notification image.
integer
Audience segment to receive the push. Do not combine with another target mode.
boolean
Set true to explicitly confirm immediate delivery to the website’s full reachable audience. This is not sent to AimTell and cannot be combined with another target mode.
string
Key used to replace an existing visible notification on a device.
array
Up to two notification action buttons. Each button requires non-empty title and link values.
array
Explicit AimTell subscriber UIDs to receive the push. Do not combine with another target mode.
string
One subscriber alias, such as a username, user ID, or email. Do not combine with another target mode.
integer
Seconds before the notification hides automatically, from 0 (persistent) through 255.

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: AIMTELL_SET_SUBSCRIBER_ATTRIBUTESSet custom attributes on one subscriber identified by subscriber UID, user alias, or email alias; supplied aliases may also be associated with the subscriber.

Input Parameters

integer
required
AimTell website ID that owns the subscriber.
object
required
Custom attribute names and JSON-compatible values to set on the subscriber.
string
User alias used to identify or associate the subscriber.
string
Email alias used to identify or associate the subscriber.
string
AimTell subscriber UID; provide at least one subscriber identifier.

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: AIMTELL_UPDATE_MANUAL_CAMPAIGNUpdate the content or targeting of an unscheduled, unsent, non-A/B manual campaign draft without scheduling or sending it.

Input Parameters

string
New notification body text.
New destination URL.
string
New internal campaign name.
string
New notification title.
string
New HTTPS custom icon URL.
integer
New expiration time in seconds.
string
New HTTPS custom image URL.
integer
required
Manual campaign ID from AIMTELL_LIST_CAMPAIGNS or AIMTELL_CREATE_MANUAL_CAMPAIGN.
array
Replacement audience segment IDs. Pass an empty list to clear targeting segments.

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: AIMTELL_UPDATE_SEGMENTChange the name or audience definition of an existing AimTell segment.

Input Parameters

string
New human-readable segment name.
string
New AimTell segment definition expression.
integer
required
Segment ID from AIMTELL_LIST_SEGMENTS or AIMTELL_CREATE_SEGMENT.

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