Skip to main content
Engage Platform logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 18
  • Triggers: 0
  • Slug: ENGAGE_PLATFORM
  • Version: 20261030_00

Tools

Slug: ENGAGE_PLATFORM_ADD_USER_TO_ACCOUNTSAdd a customer to one or more Engage accounts, optionally assigning a role in each account.

Input Parameters

string
required
Application UID of the customer to add to the accounts.
array
required
Account application UIDs and optional membership roles; must not be empty.

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: ENGAGE_PLATFORM_ADD_USER_TO_LISTSAdd and subscribe an existing user to one or more Engage lists. This tool does not remove list memberships or implement bulk removal.

Input Parameters

string
required
Application UID of the existing user to subscribe.
array
required
One or more Engage internal list IDs to add and subscribe the user to.

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: ENGAGE_PLATFORM_ARCHIVE_LISTArchive a list so it disappears from list results and cannot receive new subscribers. This is not permanent deletion; direct retrieval may still return the archived record.

Input Parameters

string
required
Engage internal list ID to archive.
boolean
required
Must be true to confirm the list will stop accepting subscribers and disappear from list 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
Slug: ENGAGE_PLATFORM_CREATE_LISTCreate an Engage user list and return its Engage list ID for subscription tools.

Input Parameters

string
required
List title, at most 64 characters.
string
List description, at most 255 characters.
boolean
Whether new subscribers require double opt-in.
string
HTTP or HTTPS redirect URL associated with the list.

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: ENGAGE_PLATFORM_CREATE_USERCreate an Engage customer or account with a caller-chosen application UID. Use UPSERT_USER when the UID may already exist.

Input Parameters

string
required
Unique application UID containing letters, numbers, or underscores.
object
Custom attributes with string, number, or boolean values.
string
User’s email address.
array
Engage list IDs to associate at creation.
string
Phone number in international format.
array
Engage account UIDs and optional roles to associate at creation.
string
User’s last name.
string
Original creation time when importing an existing user.
string
User’s first name.
boolean
Whether to create an account rather than a customer.
string
Push-device token to attach.
string ("android" | "ios")
Platform for device_token; omit when no token is supplied.

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: ENGAGE_PLATFORM_DELETE_USER_ATTRIBUTEPermanently remove one custom meta attribute from a user. Standard fields such as first_name, last_name, email, and number cannot be removed.

Input Parameters

string
required
Application UID of the user whose custom attribute will be removed.
string
required
Exact custom meta key to remove. Standard profile fields cannot be removed.
boolean
required
Must be true to confirm permanent removal of this custom 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: ENGAGE_PLATFORM_GET_LISTRetrieve an Engage list by its internal list ID. Direct retrieval can return archived lists, so a successful response does not prove the list is active.

Input Parameters

string
required
Engage internal list ID, not a user application 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: ENGAGE_PLATFORM_GET_USERRetrieve one Engage customer or account by its caller-supplied application UID, not Engage’s internal ID.

Input Parameters

string
required
Application UID supplied when the user was created.

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: ENGAGE_PLATFORM_LIST_ACCOUNT_MEMBERSList customers belonging to one Engage account identified by its application UID.

Input Parameters

string
required
Account application 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: ENGAGE_PLATFORM_LIST_LISTSReturn one cursor-controlled page of active Engage user lists. Archived lists are omitted by the provider.

Input Parameters

integer
Lists to request for this page (1-30).
string
Opaque next_cursor from the preceding list response.

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: ENGAGE_PLATFORM_LIST_USERSReturn one cursor-controlled page of Engage customers and accounts, optionally filtered by exact email.

Input Parameters

string
Exact email address to filter by.
integer
Users to request for this page (1-30).
string
Opaque continuation token from the preceding response. Pass it unchanged; it preserves the page size and email filter.

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: ENGAGE_PLATFORM_REMOVE_LIST_SUBSCRIBERCompletely remove one user’s membership from one Engage list. This differs from unsubscribe, which retains membership.

Input Parameters

string
required
Application UID of the user whose list membership will be removed.
string
required
Engage internal list ID.
boolean
required
Must be true to confirm complete list-membership removal rather than unsubscribe.

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: ENGAGE_PLATFORM_REMOVE_USER_FROM_ACCOUNTPermanently remove one customer’s membership from one Engage account. This does not delete either user record.

Input Parameters

string
required
Customer application UID.
string
required
Account application UID.
boolean
required
Must be true to confirm permanent membership removal.

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: ENGAGE_PLATFORM_SET_ACCOUNT_MEMBER_ROLESet or replace a customer’s role in one Engage account membership.

Input Parameters

string
required
Customer application UID.
string
required
Role value to assign to this account membership.
string
required
Account application UID, not an Engage internal 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: ENGAGE_PLATFORM_SET_LIST_SUBSCRIPTIONSubscribe, resubscribe, or unsubscribe an existing user on one Engage list. Unsubscribing retains the membership record; use REMOVE_LIST_SUBSCRIBER to remove it completely.

Input Parameters

string
required
Application UID of the user.
string
required
Engage internal list ID.
boolean
required
True to subscribe or resubscribe; false to unsubscribe while retaining the list membership.

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: ENGAGE_PLATFORM_TRACK_USER_EVENTAppend an immutable event to a user’s Engage activity history. A successful status confirms ingestion only; this tool cannot remove the event later. If dispatch is ambiguous, do not retry because doing so may duplicate the event.

Input Parameters

string
required
Application UID receiving the event.
string
required
Event name to record.
string
Optional string, number, or boolean event value.
string
Event occurrence time as an ISO 8601 date-time. Omit it to use Engage’s processing time.
object
Optional event properties with string, number, or boolean values.

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: ENGAGE_PLATFORM_UPDATE_LISTUpdate supplied settings on an existing Engage list without changing unspecified fields.

Input Parameters

string
Replacement title, at most 64 characters.
string
required
Engage internal list ID.
string
Replacement description, at most 255 characters.
boolean
Replacement double opt-in setting.
string
Replacement HTTP or HTTPS redirect 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: ENGAGE_PLATFORM_UPSERT_USERUpdate profile or custom attributes for an application UID, creating the user if it does not exist. Only supplied fields are sent.

Input Parameters

string
required
Application UID to update or create.
object
Custom attributes to set, with string, number, or boolean values. Engage may normalize scalar types in its response.
string
Replacement email address.
string
Replacement phone number in international format.
string
Replacement last name.
string
Replacement original creation time for an imported user.
string
Replacement first name.
boolean
Whether the user represents an account.
string
Replacement push-device token.
string ("android" | "ios")
Platform for device_token.

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