NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Engage

engage

Engage turns your customers into fans with personalised messaging; using emails, push and in-app notifications, and SMS.

Marketing AutomationEmailWeb del proveedor
Acciones
22
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (22)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Customer to AccountsENGAGE_ADD_CUSTOMER_TO_ACCOUNTSAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the customer to add to accounts

  • accountsobject[]Obligatorio

    Array of accounts to add the customer to, each with account ID and optional role

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add User to ListsENGAGE_ADD_USER_TO_LISTSAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account to add to lists

  • listsstring[]Obligatorio

    Array of list IDs to add the user to. Each ID should be a valid list identifier.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Archive ListENGAGE_ARCHIVE_LISTAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The List ID to archive

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Archive UserENGAGE_ARCHIVE_USERAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account to archive.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Convert User TypeENGAGE_CONVERT_USER_TYPEAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account to convert.

  • typestringObligatorioenum

    The entity type to convert to: customer or account.

    customeraccount

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ListENGAGE_CREATE_LISTAcción

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.

Parámetros de entrada

  • titlestringObligatorio

    List title (required)

  • descriptionstring

    String attached to the object - a description or summary of the list

  • double_optinboolean

    If true, subscribers receive a confirmation mail before being added to the list

  • redirect_urlstring

    URL to redirect users to after subscription

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create UserENGAGE_CREATE_USERAcción

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.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier for the user in your application. This will be returned as 'uid' in the response.

  • metaobject

    Object containing additional custom user attributes (string, number, or boolean values)

  • emailstring

    User's email address for communication

  • listsstring[]

    Array of List IDs to automatically subscribe the user to

  • numberstring

    User's phone number in international format (e.g., +1234567890)

  • accountsobject[]

    Array of account assignments with ID and optional role

  • last_namestring

    User's last name

  • created_atstring

    Date the user signed up. Should be a valid ISO 8601 date string

  • first_namestring

    User's first name

  • is_accountboolean

    If true, creates the user as an Account entity instead of a regular Customer

  • device_tokenstring

    Device token for push notifications

  • device_platformstring

    Device platform for push notifications. Must be 'android' or 'ios'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Subscriber From ListENGAGE_DELETE_SUBSCRIBER_FROM_LISTAcción

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.

Parámetros de entrada

  • list_idstringObligatorio

    The List ID from which to remove the subscriber

  • subscriber_uidstringObligatorio

    The subscriber's unique user ID to remove from the list

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete UserENGAGE_DELETE_USERAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account to delete. This is the ID you supplied when creating the user, not Engage's internal ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Account MembersENGAGE_GET_ACCOUNT_MEMBERSAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Account whose members to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ListENGAGE_GET_LISTAcción

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

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the List to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get User By IDENGAGE_GET_USERAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account (the ID you supplied when creating the user)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ListsENGAGE_LIST_LISTSAcción

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.

Parámetros de entrada

  • limitinteger

    Number of Lists to return. Defaults to 10. Maximum of 30.

  • next_cursorstring

    Pagination cursor for next dataset page

  • previous_cursorstring

    Pagination cursor for previous dataset page

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List UsersENGAGE_LIST_USERSAcción

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.

Parámetros de entrada

  • emailstring

    Filter results to return only users with this specific email address.

  • limitinteger

    Number of users to return. Defaults to 10. Maximum of 30.

  • next_cursorstring

    Pagination cursor for retrieving the next page of results.

  • previous_cursorstring

    Pagination cursor for retrieving the previous page of results.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Merge UsersENGAGE_MERGE_USERSAcción

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.

Parámetros de entrada

  • sourcestringObligatorio

    The ID of the user to merge. This user will be merged into the destination user and the source user profile will be removed.

  • destinationstringObligatorio

    The ID of the user that the source user is being merged into. This user will contain all merged data.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Customer from AccountENGAGE_REMOVE_CUSTOMER_FROM_ACCOUNTAcción

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

Parámetros de entrada

  • aidstringObligatorio

    User ID of the Account to remove the Customer from. Example: 'test_account_1739394000'

  • uidstringObligatorio

    User ID of the Customer to remove from the Account. Example: 'test_customer_1739394000'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Batch RequestENGAGE_SEND_BATCH_REQUESTAcción

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 remain under 100KB.

Parámetros de entrada

  • dataarrayObligatorio

    Array of batch operations. Each item must have 'type' and 'id', plus operation-specific parameters. Total request size must be under 100KB.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Subscribe User to ListENGAGE_SUBSCRIBE_USER_TO_LISTAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The List ID to subscribe the user to.

  • metaobject

    Additional user attributes as key-value pairs. Values must be string, number, or boolean.

  • emailstringObligatorio

    The user's email address (required). Requires full authentication.

  • numberstring

    The user's phone number in international format (e.g., +1234567890).

  • last_namestring

    The user's last name.

  • created_atstring

    Creation date if the user already exists (ISO 8601 format recommended).

  • first_namestring

    The user's first name.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Track User EventENGAGE_TRACK_USER_EVENTAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account

  • eventstringObligatorio

    The event title

  • valueany

    The event value. Can be string, number, or boolean

  • timestampstring

    Timestamp of the event. Defaults to current time.

  • propertiesobject

    Object containing additional event properties (string, number, or boolean values)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Account RoleENGAGE_UPDATE_ACCOUNT_ROLEAcción

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.

Parámetros de entrada

  • aidstringObligatorio

    User ID of the Account in which to update the Customer's role.

  • uidstringObligatorio

    User ID of the Customer whose role to update.

  • rolestringObligatorio

    The new role to assign to the Customer in the Account.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Subscriber StatusENGAGE_UPDATE_SUBSCRIBER_STATUSAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The List ID to update the subscriber status for

  • uidstringObligatorio

    The subscriber's user ID

  • subscribedbooleanObligatorio

    Set to true to subscribe or re-subscribe the user, false to unsubscribe

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update UserENGAGE_UPDATE_USERAcción

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.

Parámetros de entrada

  • uidstringObligatorio

    User ID of the Customer or Account to update. This is the unique identifier for the user in your system.

  • metaobject

    Object containing additional user attributes to add or update. Use this for custom properties like plan, location, preferences, etc.

  • emailstring

    User's email address. Updating email requires full authentication.

  • numberstring

    User's phone number in international format (e.g., +1234567890).

  • last_namestring

    User's last name.

  • created_atstring

    Date the user signed up. Should be a valid date string in ISO format.

  • first_namestring

    User's first name.

  • is_accountboolean

    If true, converts user to account. If false and entity is account, converts to user.

  • device_tokenstring

    User's device token for push notifications.

  • device_platformstring

    Device platform: android or ios.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not