ActiveCampaign

1. Overview

ActiveCampaign is a comprehensive platform that integrates customer experience automation, email marketing, marketing automation, sales automation, and CRM functionalities. It is designed to help businesses of all sizes build meaningful connections with their customers and automate their marketing and sales processes.

With GoInsight's Activecampaign node, you can seamlessly integrate powerful customer relationship management and marketing automation capabilities into your workflows. You can manage the entire lifecycle of core resources within ActiveCampaign, including:

• Contact and Account Management: Create, update, delete, and retrieve information for Contacts and Accounts, and associate contacts with accounts.
• Sales Process Automation: Manage various stages of the sales process, including creating and updating Deals, Pipelines, and Stages.
• Marketing Automation: Perform granular management of contacts, such as adding or removing Tags and adding contacts to different marketing Lists.
• E-commerce Integration: Manage e-commerce related customer and order data, unifying marketing and sales data.

2. Prerequisites

Before using this node, you need to meet the following conditions:

• Have a valid Activecampaign account.
• Obtain an API URL and API Key from your ActiveCampaign account for authentication. You may need administrator privileges to access these credentials.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credential Configuration Guide.

4. Supported Operations

Summary

This Activecampaign node provides a range of operations to manage your customer, sales, and marketing data. The table below summarizes all supported operations. You can click on the operation name to jump to the corresponding detailed description.

Operation Details

Create an Account

Create a new account in ActiveCampaign.

Input Parameters:

• AccountData: Fields for creating an account, which must follow the ActiveCampaign API requirements for creating an account. (e.g., name, accountUrl, owner)

Output:

• AccountId (string): The ID of the created account.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if an error occurred; otherwise, it is empty.

Delete an Account

Delete an existing account from ActiveCampaign.

Input Parameters:

• AccountId: The ID of the account to be deleted. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the file was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get an Account

Retrieve the details of a single account.

Input Parameters:

• AccountId: The ID of the account to retrieve. (Must be greater than zero)

Output:

• Account (object): A JSON object representing the account details retrieved from ActiveCampaign.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get Many Accounts

Retrieve a list of accounts, with support for pagination and search.

Options:

• Limit: The number of accounts to retrieve per request, must be >= 1.
• Offset: The pagination offset, must be >= 0.
• SearchName: A search query for the account name.

Output:

• Accounts (object-array): A JSON list of accounts.
• Total (number): The total number of accounts matching the criteria.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error description if an error occurred; otherwise, it is empty.

Update an Account

Update an existing account's information.

Input Parameters:

• AccountId: The ID of the account to update.

Options:

• Owner: The ID of the owner.
• Name: The name of the account.
• AccountUrl: The URL of the account.

Output:

• Account (object): A JSON object representing the account details retrieved from ActiveCampaign.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if an error occurred; otherwise, it is empty.

Create an Account Contact

Create a new association between an account and a contact.

Input Parameters:

• AssociationData: A dictionary containing the new association data. It should include the following keys: contact, account, jobTitle.

Output:

• AssociationId (string): The response content from creating the association.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error description if an error occurred; otherwise, it is empty.

Delete an Account Contact

Delete an existing association between an account and a contact.

Input Parameters:

• AssociationId: The ID of the account association to delete. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the file was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get an Account Contact

Retrieve the details of a single account-contact association.

Input Parameters:

• AssociationId: The ID of the account contact. (Must be greater than zero)

Output:

• AccountContact (object): The contact details of the account.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get Many Account Contacts

Retrieve a list of account-contact associations.

Options:

• Limit: The number of account contacts to return per request, with a minimum value of 1.

Output:

• AccountContacts (object-array): The contact details of the accounts.
• Total (number): The total number of deals matching the criteria.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, which is an empty string on success.

Update an Account Contact

Update an existing account-contact association's information.

Input Parameters:

• AssociationId: The ID of the account association to update.
• AssociationData: A dictionary containing the new association data. It should include the following keys: contact, account, jobTitle.

Output:

• AccountContact (object): A JSON dictionary of the account contact list.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error description if an error occurred; otherwise, it is empty.

Create a Connection

Create a new connection resource.

Input Parameters:

• ConnectionData: Fields for the connection to be created, following the API requirements for creating a connection. (service, externalid, name, logoUrl, linkUrl, listId)

Output:

• ConnectionId (string): The unique identifier of the created connection.
• StatusCode (number): The HTTP status code returned by the API: 201 (Created), or other error codes.
• ErrorMessage (string): Returns an error message if the request fails, empty on success.

Delete a Connection

Delete an existing connection.

Input Parameters:

• ConnectionId: The ID of the connection to be deleted. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the file was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get a Connection

Retrieve the details of a single connection resource.

Input Parameters:

• ConnectionId: The unique identifier of the created connection. (Must be greater than zero)

Output:

• Connection (object): A JSON object of the connection.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the request fails, empty on success.

Get Many Connections

Retrieve multiple connection resources.

Options:

• FilterService: Filter by the external service name.
• FilterExternalId: Filter by the external ID associated with the connection.

Output:

• Connections (object-array): A list of retrieved connection objects.
• Total (number): The total number of connections.
• StatusCode (number): The HTTP status code of the API call: 200 for success, 500 for internal error, -1 for parameter validation error.
• ErrorMessage (string): An error description, which is an empty string on success.

Update a Connection

Update an existing connection.

Input Parameters:

• ConnectionId: The unique identifier of the connection to be updated.
• ConnectionData: Fields for the connection to be created, following the API requirements for creating a connection. (service, externalid, name, logoUrl, linkUrl)

Output:

• Connection (object): A JSON object representing the connection details retrieved from ActiveCampaign.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if an error occurred; otherwise, it is empty.

Create a Contact

Create a new contact in ActiveCampaign.

Input Parameters:

• ContactData: Fields for the contact to be created, following the ActiveCampaign API requirements for creating a contact. For example: {"email":"test@example.com","firstName":"John"}.

Output:

• ContactId (string): The unique identifier of the created contact.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns error details if an error occurred; otherwise, it is empty.

Delete a Contact

Delete an existing contact.

Input Parameters:

• ContactId: The ID of the contact to be deleted. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the file was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get a Contact

Retrieve the details of a single contact.

Input Parameters:

• ContactId: The ID of the contact to retrieve. (Must be greater than zero)

Output:

• Contact (object): A JSON object representing the contact details retrieved from ActiveCampaign.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get Many Contacts

Retrieve a list of contacts, with support for pagination and filtering.

Options:

• Limit: The number of customers to retrieve per request, must be >= 1.
• Offset: The pagination offset, with a minimum value of 0.
• Email: Filter by email.
• Phone: Filter by phone.
• OrdersId: Sort order for orders_id, either ASC or DESC.
• OrdersEmail: Sort order for orders_email, either ASC or DESC.

Output:

• Contacts (object-array): A JSON list of the contact list.
• Total (number): The total number of deals matching the criteria.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error description if an error occurred; otherwise, it is empty.

Update a Contact

Update an existing contact's information.

Input Parameters:

• ContactId: The ID of the contact to update.
• ContactData: Fields for updating the contact, passed as a JSON string if it's a list or dictionary. ('{"contact": {"email": "johndoe@example.com", "firstName": "John", "lastName": "Doe", "phone": "123456789"}}')

Output:

• Contact (object): A JSON dictionary representing the contact details retrieved from ActiveCampaign.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if an error occurred; otherwise, it is empty.

Add a Contact Tag

Add a tag to a specified contact.

Input Parameters:

• ContactTags: Create a contact tag object. ({"contact": 5, "tag": 1})

Output:

• ContactTagId (string): The ID of the contactTag to be created.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error description if an error occurred; otherwise, it is empty.

Remove a Contact Tag

Remove a tag from a specified contact.

Input Parameters:

• ContactTagId: The ID of the contact tag.

Output:

• TagRemoved (bool): Indicates whether the tag was successfully removed from the contact.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if removing the tag failed.

Create a Deal

Create a new deal in ActiveCampaign.

Input Parameters:

• DealData: A dictionary containing the new deal data. It should include the following keys: - title (str): The title of the deal. - contact (int): The ID of the contact associated with the deal. - value (float): The value of the deal. - currency (str): The currency of the deal. - stage (int): The ID of the stage the deal is in. - pipeline (int): The ID of the pipeline the deal belongs to.

Output:

• DealId (string): The ID of the created deal.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if creating the deal failed.

Delete a Deal

Delete an existing deal.

Input Parameters:

• DealId: The ID of the deal to delete. (Must be greater than zero)

Output:

• DealDeleted (bool): Indicates whether the deal was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if deleting the deal failed.

Get a Deal

Retrieve the details of a single deal.

Input Parameters:

• DealId: The ID of the deal to retrieve. (Must be greater than zero)

Output:

• DealData (object): The retrieved deal data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if retrieving the deal failed.

Get Many Deals

Retrieve a list of deals, with support for filtering and sorting.

Options:

• Search: A search string to filter deals by title.
• OrderTitle: The sort direction for deals. Can be ASC or DESC. Defaults to ASC.

Output:

• Deals (object-array): The retrieved deal data.
• Total (number): The total number of deals matching the criteria.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if retrieving deals failed.

Update a Deal

Update an existing deal's information.

Input Parameters:

• DealId: The ID of the deal to update.

Options:

• DealData: The updated deal data. (e.g., {'title': 'New Deal_1757313463', 'value': 45600, 'currency': 'usd'})

Output:

• DealData (object): The updated deal data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Create a Deal Note

Add a note to a specified deal.

Input Parameters:

• DealId: The ID of the deal to add a note to.

Options:

• NoteText: The text content of the note.

Output:

• NoteId (string): The ID of the created note.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Update a Deal Note

Update an existing deal note.

Input Parameters:

• NoteId: The ID of the deal note to update.

Options:

• DealId: The ID of the deal associated with the note.
• NoteText: The updated text content of the note.

Output:

• NoteData (object): The updated note data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Create an Ecommerce Customer

Create an e-commerce customer.

Input Parameters:

• Email: The customer's email address.
• ConnectionId: The connection object ID for the service the customer originated from.
• ExternalId: The customer's ID in the external service.

Options:

• AcceptsMarketing: Indicates whether the customer has opted-in to receive marketing communications.

Output:

• EcommerceCustomerId (string): The ID of the created customer data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Delete an Ecommerce Customer

Delete an e-commerce customer.

Input Parameters:

• EcommerceCustomerId: The ID of the e-commerce customer to delete. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the customer was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if deleting the customer failed.

Get an Ecommerce Customer

Retrieve an e-commerce customer by ID or email.

Options:

• EcommerceCustomerId: The ID of the e-commerce customer to retrieve.
• Email: The email of the e-commerce customer to retrieve.

Output:

• EcommerceCustomers (object-array): The retrieved customer data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if retrieving the customer failed.

Get Ecommerce Customers

Retrieve a list of e-commerce customers, with support for filtering.

Options:

• Limit: The number of customers to retrieve (default: 20, max: 100).
• Offset: The pagination offset (default: 0).
• Search: A search string to filter customers by name.
• Email: Filter customers by email address.
• ConnectionId: Filter customers by connection ID.

Output:

• CustomersDatas (object-array): The retrieved customer data.
• TotalCount (number): The total number of customers matching the criteria.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if retrieving customers failed.

Update an Ecommerce Customer

Update an existing e-commerce customer's information.

Input Parameters:

• EcommerceCustomerId: The ID of the e-commerce customer to update.

Options:

• EcommerceCustomer: A dictionary containing e-commerce customer data. Should include the keys: externalid, connectionid, email, acceptsMarketing.

Output:

• EcommerceCustomer (object): The updated e-commerce customer data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Create an Ecommerce Order

Create an e-commerce order.

Input Parameters:

• OrderData: Order information, including customer, products, and order details.

Output:

• OrderId (string): The ID of the created order.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Delete an Ecommerce Order

Delete an e-commerce order.

Input Parameters:

• OrderId: The ID of the e-commerce order to delete. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the order was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get an Ecommerce Order

Retrieve the details of a single e-commerce order.

Input Parameters:

• OrderId: The ID of the order to retrieve. (Must be greater than zero)

Output:

• OrderData (object): The retrieved order data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails, otherwise empty.

Get Ecommerce Orders

Retrieve a list of e-commerce orders, with support for pagination.

Options:

• Limit: The number of orders to retrieve per request (for pagination).
• Offset: The pagination offset used to determine which orders to retrieve.
• CustomerId: The ID of the e-commerce customer to retrieve.
• ExternalId: The external ID of the e-commerce customer.

Output:

• Orders (object-array): A JSON list of e-commerce orders, including fields.
• Total (number): The total number of customers matching the criteria.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Update an Ecommerce Order

Update an existing e-commerce order's information.

Input Parameters:

• OrderId: The ID of the e-commerce order to update.
• OrderData: Updated order information, including customer, products, and order details.

Output:

• EcommerceOrder (object): The updated e-commerce order.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get Ecommerce Order Product by ProductId

Retrieve a list of orders related to a product ID.

Input Parameters:

• ProductId: The ID of the product for which to retrieve orders.

Output:

• Product (object): A dictionary containing the ActiveCampaign API response.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get Ecommerce Order Products

Retrieve a list of products.

Options:

• Limit: Number of results to return per page.
• Offset: Number of results to skip.

Output:

• Products (object-array): A list of dictionaries containing the retrieved order products.
• TotalCount (number): The total number of results.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Get Ecommerce Order Products by OrderId

Retrieve a list of products included in an order by order ID.

Input Parameters:

• OrderId: The ID of the order for which to retrieve products.

Options:

• Limit: Number of results to return per page.
• Offset: Number of results to skip.

Output:

• Products (object-array): A list of dictionaries containing the retrieved order products.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Add a Contact to a List

Add a contact to a list.

Input Parameters:

• ContactId: The ID of the contact to add to the list. (Must be greater than zero)
• ListId: The ID of the list to add the contact to. (Must be greater than zero)

Options:

• SourceId: The source ID used to create the contact. (Set to "4" when re-subscribing a contact to a list)
• Status: Set to "1" to subscribe the contact to the list. Set to "2" to unsubscribe the contact from the list.

Output:

• ContactList (object): The contactList record created in ActiveCampaign.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if an error occurred.

Create a List

Create a new contact list.

Input Parameters:

• ListData: A dictionary containing the new list data. It should include the following keys: name, stringid, sender_url, sender_reminder, channel.

Output:

• ListId (string): The ID of the newly created list.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, empty if there are no errors.

Delete a List

Delete an existing list.

Input Parameters:

• ListId: The ID of the list to delete.

Output:

• Deleted (bool): Indicates whether the stage was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get a List

Retrieve the details of a single list.

Input Parameters:

• ListId: The ID of the list to retrieve.

Output:

• List (object): The retrieved list data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get Many Lists

Retrieve a list of lists, with support for filtering and sorting.

Options:

• Limits: The number of contacts to retrieve per request, must be >= 1.
• Name: Filter by list name.
• FilterOperator: The operator for filtering by list name.
• FilterOrder: The sort order for filtering by list name.

Output:

• Lists (object-array): A list in JSON string format.
• Total (number): The total number of lists.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error description if an error occurred; otherwise, it is empty.

Remove a Contact from a List

Remove a contact from a list.

Input Parameters:

• ContactId: The ID of the contact to remove. (Must be greater than zero)
• ListId: The ID of the list from which to remove the contact. (Must be greater than zero)

Output:

• RemovedCount (number): The number of subscriptions removed.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if an error occurred.

Create a Pipeline

Create a new sales pipeline.

Input Parameters:

• DealGroup: A dictionary containing the new pipeline data. It should include the following keys: title, currency, allgroups, allusers, autoassign.

Output:

• PipelineId (string): The ID of the created pipeline.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, empty if there are no errors.

Delete a Pipeline

Delete an existing pipeline.

Input Parameters:

• PipelineId: The ID of the pipeline to retrieve. (Must be greater than zero)

Output:

• DealGroupDeleted (bool): Indicates whether the deal was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get a Pipeline

Retrieve the details of a single pipeline.

Input Parameters:

• PipelineId: The ID of the pipeline to retrieve. (Must be greater than zero)

Output:

• DealGroup (object): The retrieved deal group data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get Many Pipelines

Retrieve a list of pipelines, with support for filtering and sorting.

Options:

• FilterTitle: Filter by pipeline title.
• FilterStage: Filter by whether the pipeline has deal stages. Can be 1 or 0. If 1, only pipelines with at least one stage are returned.
• OrderTitle: Sort by pipeline title. Can be ASC or DESC. Defaults to ASC.
• OrderPopular: Sort by the popularity of the pipeline. Can be ASC or DESC. Defaults to ASC.

Output:

• DealGroups (object-array): A list of pipeline objects.
• Total (number): The total number of pipelines.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, empty if there are no errors.

Update a Pipeline

Update an existing pipeline's information.

Input Parameters:

• PipelineId: The ID of the pipeline to update. (Must be greater than zero)

Options:

• DealGroup: A dictionary containing the updated pipeline data.

Output:

• DealGroup (object): The updated pipeline data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, empty if there are no errors.

Create a Stage

Create a new stage for a specified pipeline.

Input Parameters:

• StageData: A dictionary containing the new stage data. It should include the following keys: (title, group).

Options:

• Reorder: Whether to reorder stages in the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, all stages in the same pipeline will be assigned new order values. If there are deal stages with the same order, the one with the highest ID will be assigned the lowest order.

Output:

• StageId (string): The ID of the created stage.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the request is not successful.

Delete a Stage

Delete an existing stage.

Input Parameters:

• StageId: The ID of the stage to delete. (Must be greater than zero)

Output:

• StageDeleted (bool): Indicates whether the stage was successfully deleted.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get a Stage

Retrieve the details of a single stage.

Input Parameters:

• StageId: The ID of the deal stage. (Must be greater than zero)

Output:

• DealStage (object): The retrieved deal stage data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get Many Stages

Retrieve a list of stages, with support for filtering and sorting.

Options:

• FilterTitle: Filter by the title of the deal stage. Returns all stages whose title partially matches the filter value.
• FilterGroup: Filter by the ID of the pipeline.
• OrderTitle: Sort by the title of the deal stage. Can be ASC or DESC. Defaults to ASC.

Output:

• DealStages (object-array): A list of stage objects.
• Total (number): The total number of stages.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, empty if there are no errors.

Update a Stage

Update an existing stage's information.

Input Parameters:

• StageId: The ID of the stage to update. (Must be greater than zero)

Options:

• StageData: Fields for the stage to be created in JSON format.
• Reorder: Whether to reorder stages in the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, all stages in the same pipeline will be assigned new order values. If there are deal stages with the same order, the one with the highest ID will be assigned the lowest order.

Output:

• DealStage (object): The updated stage data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): An error description, empty if there are no errors.

Create a Tag

Create a new tag.

Input Parameters:

• TagName: A dictionary containing the tag data. It should include the following keys: tag, tagType, description.

Output:

• TagId (string): The ID of the created tag.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): A descriptive error message explaining why the request failed.

Delete a Tag

Delete an existing tag by ID.

Input Parameters:

• TagId: The ID of the tag to delete. (Must be greater than zero)

Output:

• Deleted (bool): Indicates whether the tag was successfully deleted.
• StatusCode (number): Operation status code: 200 or 204 (Success), 404 (Tag not found), 401 (Unauthorized), 403 (Forbidden), 500 (Server Error), -1 (Parameter Error).
• ErrorMessage (string): Returns an error description if the operation failed, empty string on success.

Get a Tag

Retrieve the details of a single tag by ID.

Input Parameters:

• TagId: The ID of the tag to retrieve. (Must be greater than zero)

Output:

• Tag (object): The retrieved tag data.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

Get Many Tags

Retrieve a list of tags, with support for search and sorting.

Options:

• SearchText: Text to search for in the tag name.
• SearchOperator: The operator for the search (values: eq, neq, lt, lte, gt, gte, contains, starts_with).
• SearchOrder: The order to sort the results (values: asc, desc, weight).

Output:

• Tags (object-array): The retrieved tag data.
• Total (number): Additional metadata about the request.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if any issues were encountered; empty on success.

Update a Tag

Update an existing tag by ID.

Input Parameters:

• TagId: The ID of the tag to update.

Options:

• TagData: A dictionary containing the tag data. It should include the following keys: tag, tagType, description.

Output:

• Tag (object): The updated tag.
• StatusCode (number): HTTP status code or operation status code (-1 for parameter error, 500 for exception).
• ErrorMessage (string): Returns an error message if the operation fails.

5. Example Usage

This section will guide you through creating a simple workflow to create a new contact in your Activecampaign account.

Workflow Overview

A basic workflow consists of three nodes: Start -> Activecampaign: Create a Contact -> Answer. When the workflow is triggered, it uses the Activecampaign node to add a new contact's information to your account.

Step-by-Step Guide

1. Add a Tool Node:
   • On the workflow canvas, click the "+" sign to add a new node.
   • In the pop-up panel, select the "Tools" tab.
   • Find and select Activecampaign from the tool list.
   • In the list of supported operations for Activecampaign, click to select Create a Contact, which will add the corresponding node to the canvas.
2. Configure the Node:
   • Click on the newly added Create a Contact node, and its configuration panel will expand on the right.
   • Credential Configuration: At the top of the panel, find the credential field. Click the dropdown menu and select your pre-configured Activecampaign credential.
   • Parameter Entry:
   • ContactData: This is the core parameter for this operation and requires data in JSON object format. You need to provide the contact's details. For example, to create a contact named "John Doe" with the email "john.doe@example.com", you should enter the following JSON content:
3. Run and Validate:
   • Once all required parameters are correctly filled in, the error prompt in the top right corner of the workflow canvas will disappear.
   • Click the "Run" button in the top right corner of the canvas to execute the workflow.
   • After successful execution, you can click the log icon in the top right corner to view the detailed input and output of the node. In the output, you should see a newly generated ContactId, which indicates that the contact was created successfully. You can also log in to your Activecampaign account dashboard to verify.

Final Workflow Display

After completing the steps above, your entire workflow is configured. After clicking "Run", a new contact will be successfully created in your Activecampaign account.

6. FAQs

Q: Why am I receiving a "401 Unauthorized" error?

A: This error is usually related to credential configuration. Please check the following:

• API URL and API Key: Ensure that the API URL and API Key in your Activecampaign credentials configured in GoInsight are completely correct, with no extra spaces or characters.
• Credential Validity: Confirm that your API Key is still valid in the Activecampaign dashboard and has not been disabled or regenerated.

Q: How do I find a specific List ID or Pipeline ID to use in other operations?

A: You can accomplish this in two steps:

1. First, use the Get Many Lists or Get Many Pipelines operation to get a list of all your lists or pipelines.
2. After running that node, look through the output log to find the specific list or pipeline you need and note its id field value.
3. You can then use this ID in other nodes that require a ListId or PipelineId (such as Add a Contact to a List).

Q: The "Create a Contact" operation failed. What could be the reason?

A: Please check the following common causes:

• Data Format: Ensure the JSON format you entered in the ContactData field is correct. A common mistake is missing the outer {"contact": { ... }} structure.
• Required Fields: At a minimum, a valid email address is required.
• Email Already Exists: If the contact's email you are trying to create already exists in your Activecampaign account, the operation may fail or be handled in a specific way by the system.

7. Official Documentation

For more detailed information about the ActiveCampaign API, please refer to the official documentation:

Activecampaign Official API Documentation