Engage Platform integration

Add User to Accounts

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

Add User to Lists

Add and subscribe an existing user to one or more Engage lists. This tool does not remove list memberships or implement bulk removal.

Archive List

Archive 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.

Create List

Create an Engage user list and return its Engage list ID for subscription tools.

Create User

Create an Engage customer or account with a caller-chosen application UID. Use UPSERT_USER when the UID may already exist.

Delete User Attribute

Permanently remove one custom meta attribute from a user. Standard fields such as first_name, last_name, email, and number cannot be removed.

Get List

Retrieve 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.

Get User

Retrieve one Engage customer or account by its caller-supplied application UID, not Engage's internal ID.

List Account Members

List customers belonging to one Engage account identified by its application UID.

List Lists

Return one cursor-controlled page of active Engage user lists. Archived lists are omitted by the provider.

List Users

Return one cursor-controlled page of Engage customers and accounts, optionally filtered by exact email.

Remove List Subscriber

Completely remove one user's membership from one Engage list. This differs from unsubscribe, which retains membership.