NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Mailercloud connects to a Nagent workspace with an API key. Once it is connected, agents can call 6 Mailercloud actions, such as "Create List", "Create custom property" and "Get Client Plan". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Mailercloud, with input parameters and output schema.
MAILERCLOUD_CREATE_LISTTool to create a new recipient list in Mailercloud for storing and managing contacts. Use when you need to create a new mailing list for organizing contacts.
Input parameters
Name of the list to create. This is the display name that will be used to identify the list.
Type of list to create. Use 1 for Subscription List.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAILERCLOUD_CREATE_PROPERTYCreate a custom property for contacts in Mailercloud. Custom properties store specific information for contact records. Maximum of 100 properties allowed per account.
Input parameters
Name of the custom property to create. This will be used to identify the property when storing contact information.
Type of the custom property. Defines the kind of data that can be stored in this property. Common types include 'text' for string values, 'number' for numeric values, and 'date' for date values.
Optional description of the custom property. Helps document the purpose and usage of the property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAILERCLOUD_DELETE_PROPERTYTool to delete a custom contact property by ID. Use when removing unused custom fields from contacts. Cannot delete properties used in webforms.
Input parameters
Unique identifier of the custom property to delete. WARNING: You cannot delete a property if it is used in a webform.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAILERCLOUD_GET_CLIENT_PLANTool to retrieve client plan information from Mailercloud. Use when you need to check the current subscription status, plan details, or verify API connectivity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAILERCLOUD_SEARCH_CONTACTSTool to retrieve contacts in a specific list with pagination. Use when you need to list or search contacts within a known list ID.
Input parameters
Page number for pagination (must be at least 1)
Number of records per page (1-100)
ID of the list to search contacts in
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAILERCLOUD_UPDATE_PROPERTYTool to update a custom property of contacts in Mailercloud. Use when you need to modify the name or description of an existing custom property. Note: Editing custom property type using this API is not possible - you can only edit the name and description.
Input parameters
New name for the custom property. If not provided, the current name will be retained.
New description for the custom property. If not provided, the current description will be retained.
The ID of the property to update. Use MAILERCLOUD_LIST_PROPERTY to find available property IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 6 Mailercloud actions on Nagent, including "Create List", "Create custom property" and "Get Client Plan". Create List: Create a new recipient list in Mailercloud for storing and managing contacts. Each action is listed on this page with its input parameters and its output.
Mailercloud connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create List takes 2 required inputs: name and list_type. It returns data, error and successful.