18 available actions

What your AI agent can do in Engage Platform

Engage Platform provides customer data, account, list, event, batch, and transactional messaging APIs for customer engagement workflows. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.

Common starting points

Get ListRetrieve an Engage list by its internal list ID.
Get UserRetrieve one Engage customer or account by its caller-supplied application UID, not Engage's internal ID.
Add User to AccountsAdd a customer to one or more Engage accounts, optionally assigning a role in each account.
Add User to ListsAdd and subscribe an existing user to one or more Engage lists.
Update ListUpdate supplied settings on an existing Engage list without changing unspecified fields.
Archive ListArchive a list so it disappears from list results and cannot receive new subscribers.

Browse all 18 actions by capability

Open a capability to see every supported action and its description.

Find & reviewLook up and review existing recordsView 5 actionsHide actions

Get ListRetrieve an Engage list by its internal list ID.
Get UserRetrieve one Engage customer or account by its caller-supplied application UID, not Engage's internal ID.
List Account MembersList customers belonging to one Engage account identified by its application UID.
List ListsReturn one cursor-controlled page of active Engage user lists.
List UsersReturn one cursor-controlled page of Engage customers and accounts, optionally filtered by exact email.

Create & communicateCreate records or send supported messagesView 4 actionsHide actions

Add User to AccountsAdd a customer to one or more Engage accounts, optionally assigning a role in each account.
Add User to ListsAdd and subscribe an existing user to one or more Engage lists.
Create ListCreate an Engage user list and return its Engage list ID for subscription tools.
Create UserCreate an Engage customer or account with a caller-chosen application UID.

Update & manageChange and manage existing recordsView 5 actionsHide actions

Archive ListArchive a list so it disappears from list results and cannot receive new subscribers.
Set Account Member RoleSet or replace a customer's role in one Engage account membership.
Set List SubscriptionSubscribe, resubscribe, or unsubscribe an existing user on one Engage list.
Update ListUpdate supplied settings on an existing Engage list without changing unspecified fields.
Upsert UserUpdate profile or custom attributes for an application UID, creating the user if it does not exist.

Remove & cancelRemove records or cancel supported workView 3 actionsHide actions

Delete User AttributePermanently remove one custom meta attribute from a user.
Remove List SubscriberCompletely remove one user's membership from one Engage list.
Remove User From AccountPermanently remove one customer's membership from one Engage account.

Other actionsSpecialist and administrative actions.View 1 actionHide actions

Track User EventAppend an immutable event to a user's Engage activity history.

Connection record

A connection you can control.

Sign-in: Customer-managed key
Setup: Use a key you create and control. It is stored securely and limited to the work agreed for the role.
Boundaries: Only the approved role and actions.
Off switch: Revoke the connection from your account.

FAQ

Before you connect Engage Platform

How does the agent connect to Engage Platform?

With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.

What can the agent actually do in Engage Platform?

The page above lists the 18 actions currently available through the Engage Platform connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.

Is Engage Platform included in my plan?

Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.

How long until Engage Platform is ready?

Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.

Bring the workflow together

Ready to put Engage Platform to work?

Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.

Book a setup call Browse all connections

All product names, logos, and brands are property of their respective owners and are used for identification only. ZeroToClaw is not affiliated with or endorsed by Engage Platform.