> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Engage Platform

> Engage Platform provides customer data, account, list, event, batch, and transactional messaging APIs for customer engagement workflows.

![Engage Platform logo](https://mintcdn.com/composio-preview/r7CO9m4_UWMVFnU7/images/toolkits/engage_platform.svg?fit=max\&auto=format\&n=r7CO9m4_UWMVFnU7\&q=85\&s=eacdbc60476844f368ba6f974c3c93fd)

* **Category:** marketing automation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 18
* **Triggers:** 0
* **Slug:** `ENGAGE_PLATFORM`
* **Version:** 20261030\_00

## Tools

> [accordion] Add User to Accounts
>
> **Slug:** `ENGAGE_PLATFORM_ADD_USER_TO_ACCOUNTS`
>
> Add a customer to one or more Engage accounts, optionally assigning a role in each account.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Application UID of the customer to add to the accounts.
>
> **accounts** `array` *required*
>
> Account application UIDs and optional membership roles; must not be empty.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add User to Lists
>
> **Slug:** `ENGAGE_PLATFORM_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.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Application UID of the existing user to subscribe.
>
> **list\_ids** `array` *required*
>
> One or more Engage internal list IDs to add and subscribe the user to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive List
>
> **Slug:** `ENGAGE_PLATFORM_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.
>
> #### Input Parameters
>
> **list\_id** `string` *required*
>
> Engage internal list ID to archive.
>
> **confirm\_archive** `boolean` *required*
>
> Must be true to confirm the list will stop accepting subscribers and disappear from list results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create List
>
> **Slug:** `ENGAGE_PLATFORM_CREATE_LIST`
>
> Create an Engage user list and return its Engage list ID for subscription tools.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> List title, at most 64 characters.
>
> **description** `string`
>
> List description, at most 255 characters.
>
> **double\_optin** `boolean`
>
> Whether new subscribers require double opt-in.
>
> **redirect\_url** `string`
>
> HTTP or HTTPS redirect URL associated with the list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create User
>
> **Slug:** `ENGAGE_PLATFORM_CREATE_USER`
>
> Create an Engage customer or account with a caller-chosen application UID. Use UPSERT\_USER when the UID may already exist.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Unique application UID containing letters, numbers, or underscores.
>
> **meta** `object`
>
> Custom attributes with string, number, or boolean values.
>
> **email** `string`
>
> User's email address.
>
> **lists** `array`
>
> Engage list IDs to associate at creation.
>
> **number** `string`
>
> Phone number in international format.
>
> **accounts** `array`
>
> Engage account UIDs and optional roles to associate at creation.
>
> **last\_name** `string`
>
> User's last name.
>
> **created\_at** `string`
>
> Original creation time when importing an existing user.
>
> **first\_name** `string`
>
> User's first name.
>
> **is\_account** `boolean`
>
> Whether to create an account rather than a customer.
>
> **device\_token** `string`
>
> Push-device token to attach.
>
> **device\_platform** `string ("android" | "ios")`
>
> Platform for device\_token; omit when no token is supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete User Attribute
>
> **Slug:** `ENGAGE_PLATFORM_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.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Application UID of the user whose custom attribute will be removed.
>
> **attribute** `string` *required*
>
> Exact custom meta key to remove. Standard profile fields cannot be removed.
>
> **confirm\_delete** `boolean` *required*
>
> Must be true to confirm permanent removal of this custom attribute.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get List
>
> **Slug:** `ENGAGE_PLATFORM_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.
>
> #### Input Parameters
>
> **list\_id** `string` *required*
>
> Engage internal list ID, not a user application UID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `ENGAGE_PLATFORM_GET_USER`
>
> Retrieve one Engage customer or account by its caller-supplied application UID, not Engage's internal ID.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Application UID supplied when the user was created.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Account Members
>
> **Slug:** `ENGAGE_PLATFORM_LIST_ACCOUNT_MEMBERS`
>
> List customers belonging to one Engage account identified by its application UID.
>
> #### Input Parameters
>
> **account\_uid** `string` *required*
>
> Account application UID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Lists
>
> **Slug:** `ENGAGE_PLATFORM_LIST_LISTS`
>
> Return one cursor-controlled page of active Engage user lists. Archived lists are omitted by the provider.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Lists to request for this page (1-30).
>
> **cursor** `string`
>
> Opaque next\_cursor from the preceding list response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `ENGAGE_PLATFORM_LIST_USERS`
>
> Return one cursor-controlled page of Engage customers and accounts, optionally filtered by exact email.
>
> #### Input Parameters
>
> **email** `string`
>
> Exact email address to filter by.
>
> **limit** `integer`
>
> Users to request for this page (1-30).
>
> **cursor** `string`
>
> Opaque continuation token from the preceding response. Pass it unchanged; it preserves the page size and email filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove List Subscriber
>
> **Slug:** `ENGAGE_PLATFORM_REMOVE_LIST_SUBSCRIBER`
>
> Completely remove one user's membership from one Engage list. This differs from unsubscribe, which retains membership.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Application UID of the user whose list membership will be removed.
>
> **list\_id** `string` *required*
>
> Engage internal list ID.
>
> **confirm\_remove** `boolean` *required*
>
> Must be true to confirm complete list-membership removal rather than unsubscribe.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove User From Account
>
> **Slug:** `ENGAGE_PLATFORM_REMOVE_USER_FROM_ACCOUNT`
>
> Permanently remove one customer's membership from one Engage account. This does not delete either user record.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Customer application UID.
>
> **account\_uid** `string` *required*
>
> Account application UID.
>
> **confirm\_remove** `boolean` *required*
>
> Must be true to confirm permanent membership removal.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Account Member Role
>
> **Slug:** `ENGAGE_PLATFORM_SET_ACCOUNT_MEMBER_ROLE`
>
> Set or replace a customer's role in one Engage account membership.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Customer application UID.
>
> **role** `string` *required*
>
> Role value to assign to this account membership.
>
> **account\_uid** `string` *required*
>
> Account application UID, not an Engage internal ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set List Subscription
>
> **Slug:** `ENGAGE_PLATFORM_SET_LIST_SUBSCRIPTION`
>
> Subscribe, 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
>
> **uid** `string` *required*
>
> Application UID of the user.
>
> **list\_id** `string` *required*
>
> Engage internal list ID.
>
> **subscribed** `boolean` *required*
>
> True to subscribe or resubscribe; false to unsubscribe while retaining the list membership.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Track User Event
>
> **Slug:** `ENGAGE_PLATFORM_TRACK_USER_EVENT`
>
> Append 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
>
> **uid** `string` *required*
>
> Application UID receiving the event.
>
> **event** `string` *required*
>
> Event name to record.
>
> **value** `string`
>
> Optional string, number, or boolean event value.
>
> **timestamp** `string`
>
> Event occurrence time as an ISO 8601 date-time. Omit it to use Engage's processing time.
>
> **properties** `object`
>
> Optional event properties with string, number, or boolean values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update List
>
> **Slug:** `ENGAGE_PLATFORM_UPDATE_LIST`
>
> Update supplied settings on an existing Engage list without changing unspecified fields.
>
> #### Input Parameters
>
> **title** `string`
>
> Replacement title, at most 64 characters.
>
> **list\_id** `string` *required*
>
> Engage internal list ID.
>
> **description** `string`
>
> Replacement description, at most 255 characters.
>
> **double\_optin** `boolean`
>
> Replacement double opt-in setting.
>
> **redirect\_url** `string`
>
> Replacement HTTP or HTTPS redirect URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert User
>
> **Slug:** `ENGAGE_PLATFORM_UPSERT_USER`
>
> Update profile or custom attributes for an application UID, creating the user if it does not exist. Only supplied fields are sent.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Application UID to update or create.
>
> **meta** `object`
>
> Custom attributes to set, with string, number, or boolean values. Engage may normalize scalar types in its response.
>
> **email** `string`
>
> Replacement email address.
>
> **number** `string`
>
> Replacement phone number in international format.
>
> **last\_name** `string`
>
> Replacement last name.
>
> **created\_at** `string`
>
> Replacement original creation time for an imported user.
>
> **first\_name** `string`
>
> Replacement first name.
>
> **is\_account** `boolean`
>
> Whether the user represents an account.
>
> **device\_token** `string`
>
> Replacement push-device token.
>
> **device\_platform** `string ("android" | "ios")`
>
> Platform for device\_token.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
