Engage

Tool to add a customer to one or more account entities. Use when you need to associate a user with accounts and optionally assign roles.

Untrusted display-only summary

Tool to add a Customer or Account to one or more Lists in Engage.so. Use when you need to subscribe a user to specific lists for targeted messaging.

Untrusted display-only summary

Tool to archive a List in Engage. Use when you want to prevent new subscribers from being added to a list. Existing subscribers will not be affected.

Untrusted display-only summary

Tool to archive a user in Engage. Use when you need to deactivate a user account while preserving all historical data. The user will stop being active and all engagement and events for the user will be stopped, but all messages, logs, and related data will be preserved.

Untrusted display-only summary

Tool to convert a user between Customer and Account entity types. Use when you need to change a customer to an account or vice versa.

Untrusted display-only summary

Tool to create a new List in Engage for organizing subscribers. Use when you need to set up a new list for managing contacts or subscribers.

Untrusted display-only summary

Tool to create a new user (Customer or Account) in Engage. Use when you need to add a user with optional metadata, device tokens, or list subscriptions.

Untrusted display-only summary

Tool to remove a subscriber from a List entirely (different from unsubscribing). Use when you need to completely delete a subscriber's association with a specific list.

Untrusted display-only summary

Tool to completely delete all user data for a Customer or Account. This is a permanent, destructive action that removes all associated user data from Engage.

Untrusted display-only summary

Tool to retrieve all members (Customers) of an Account in Engage. Use when you need to list users who are part of a specific account.

Untrusted display-only summary

Tool to retrieve a single List by its ID. Use when you need to fetch details about a specific List.

Untrusted display-only summary

Tool to retrieve a single user by their user ID. Use when you need to fetch complete user information including metadata, attributes, devices, lists, segments, and message statistics.

Untrusted display-only summary

Tool to retrieve a paginated list of all Lists in Engage. Use when you need to view available Lists or iterate through all Lists in the account.

Untrusted display-only summary

Tool to retrieve a paginated list of all users in Engage. Use when you need to list users with optional filtering by email and cursor-based pagination support.

Untrusted display-only summary

Tool to merge two user profiles in Engage. The source user is merged into the destination user, and the source user profile is removed. Use when you need to consolidate duplicate user accounts or combine user data from multiple profiles into a single account.

Untrusted display-only summary

Tool to remove a Customer from an Account in Engage. Use when you need to disassociate a customer from a specific account.

Untrusted display-only summary

Tool to batch multiple create user, update user, and add user events operations into a single API call. Use when you need to perform multiple operations efficiently at the cost of one API request. The batch is queued for processing without immediate validation, so ensure all parameters are correct. Request size must r…

Untrusted display-only summary

Tool to create a user and subscribe them to an Engage.so List. Use when you need to add users to a specific list for email marketing or user segmentation. If the user already exists, they will be added to the List without creating a duplicate.

Untrusted display-only summary

Tool to add user events to Engage. Use this to track user actions and events in your application. You can later segment users based on these actions or events.

Untrusted display-only summary

Tool to update the role of a Customer in an Account or set a new one if none exists. Use when you need to assign or change a customer's role within a specific account.

Untrusted display-only summary

Tool to update a subscriber's status on a List. Use when you need to subscribe, re-subscribe, or unsubscribe a user from a specific List.

Untrusted display-only summary

Tool to update user data and attributes on Engage. Use this to update user data changes like changes in plan, name, location, etc. If the user doesn't exist, this method creates the user.

Untrusted display-only summary