Reference

Add Customer to Accounts

Links a customer or user to one or more accounts in your system, optionally assigning them specific roles for access control. This enables you to organize customers by account and define their permissions within each account.

Get Account Members

Retrieve all members or customers associated with a specific account in your Engage workspace. This helps you understand who has access to your account and manage your team or customer relationships.

Remove Customer from Account

Removes a customer's association from an account in Engage, allowing you to disassociate contacts when relationships end or accounts need to be cleaned up. This helps maintain accurate customer records and prevent outdated contact information from cluttering your communications.

Update Account Role

Assign or change a customer's role within your account, controlling their access level and permissions.

Add User to Lists

Subscribe customers or accounts to specific communication lists in Engage.so for targeted messaging campaigns. This helps you organize your audience by interests, segments, or engagement levels.

Create List

Creates a new subscriber list in Engage to organize and manage your contacts by groups or campaigns. This helps you segment your audience for targeted communication efforts.

Subscribe User to List

Add a user to a specific mailing list in Engage, creating their profile if needed and avoiding duplicates. Use this to build targeted audience segments for email campaigns and marketing initiatives.

Archive List

Archive a list in Engage to stop accepting new subscribers while keeping existing ones intact. Use this when you want to close off a list from new signups without losing your current audience.

Delete Subscriber From List

Permanently removes a subscriber's entire association with a specific mailing list, completely deleting their profile from that list. Use this when you need to fully eliminate a contact from a list rather than just unsubscribing them.

Get List

Retrieve detailed information about a specific contact list, including its configuration, members, and settings. Use this to view list details, verify list membership, or pull data for list management tasks.

List Lists

Retrieve all your email lists in Engage to view available audience segments and manage your subscriber groups. This helps you organize and track which lists exist in your account.

Update Subscriber Status

Updates a subscriber's status on a mailing list, allowing you to subscribe, re-subscribe, or unsubscribe contacts based on their engagement or preferences. This helps you manage your email list and keep it aligned with subscriber interests.

Batch Request

Combine multiple user management and event tracking operations into a single efficient API request to save bandwidth and reduce processing overhead. This is ideal when you need to create users, update profiles, or log events in bulk without waiting for individual responses.

Track User Event

Records user actions and behaviors in your application so you can understand customer engagement patterns and create targeted segments based on their activity.

Create User

Add a new customer or team member to your Engage account with optional profile information, device tokens for push notifications, and list subscriptions. This enables you to expand your contact database and set up communication channels for new users.

Update User

Updates or creates customer information in Engage, including details like name, plan, location, and other custom attributes. Use this to keep your customer database synchronized with changes in their status or profile.

Archive User

Deactivate a user account while keeping all their historical messages and data intact. This preserves your communication records without permanently deleting the user's information.

Convert User Type

Change how a contact is classified in your system—convert between treating them as an individual customer or an organizational account. This helps you manage different relationship types as your business needs evolve.

Delete User

Permanently removes a customer or account and all their associated data from your Engage system. Use this when you need to completely delete a user's presence from your communication platform.

Get User By ID

Retrieve complete profile information for a specific user including their contact details, attributes, devices, and messaging history. Use this to access detailed user data for personalization, analysis, or account management.

List Users

Retrieve all users in your Engage workspace with optional filtering by email and pagination support, helping you manage and organize your team members.

Merge Users

Consolidates duplicate user accounts by merging a source user profile into a destination user profile, eliminating redundancy and ensuring all user data is unified under a single account.