NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Mailsoftly connects to a Nagent workspace with an API key. Once it is connected, agents can call 20 Mailsoftly actions, such as "Add Contact to Contact List", "Add Custom Field to Contact" and "Create Contact". 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 Mailsoftly, with input parameters and output schema.
MAILSOFTLY_ADD_CONTACT_TO_CONTACT_LISTTool to add an existing contact to a specific contact list. Use when you need to add a contact to a contact list in Mailsoftly.
Input parameters
ID of the existing contact to add to the contact list.
ID of the contact list to add the contact to.
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
MAILSOFTLY_ADD_CUSTOM_FIELD_TO_CONTACTTool to add a custom field value to an existing contact. Use when you need to store additional custom data on a contact record.
Input parameters
ID of the contact to which the custom field will be added.
Name of the custom field to add.
Value of the custom field to add.
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
MAILSOFTLY_ASSIGN_TAGS_TO_CONTACTTool to assign multiple tags to an existing contact at once. Skips tags if they are already assigned to the contact. Use when you need to categorize or label a contact with one or more tags in Mailsoftly.
Input parameters
Array of tags to assign to the contact. Each tag must have a tag_name and tag_color.
ID of the contact to assign tags to.
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
MAILSOFTLY_AUTHENTICATE_FIRMTool to validate the API key and retrieve firm details. Use when confirming credentials before making other Mailsoftly API calls.
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
MAILSOFTLY_CREATE_CONTACTTool to create a new contact for the authenticated firm with email, first name, and last name. Use when adding new contacts to the firm's contact list.
Input parameters
Email address of the contact. This is required to create a contact.
Last name of the contact.
First name of the contact.
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
MAILSOFTLY_CREATE_CONTACT_LISTTool to create a new contact list for the authenticated firm. Use when organizing contacts into separate lists for targeted campaigns.
Input parameters
Name of the contact list to create.
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
MAILSOFTLY_CREATE_EMAILSTool to create one or more email drafts in Mailsoftly. Use when drafting emails for campaigns or communications. If contact_list_id is not provided, the system automatically creates a contact list from the provided recipients.
Input parameters
HTML content of the email body (required if not using mailLists).
Custom name for the email draft.
Subject line of the email draft (required if not using mailLists).
Array of attachment objects (maximum 5 attachments per email).
Email address for replies.
Array of email draft objects for creating multiple drafts at once. If provided, this takes precedence over individual subject/body/recipients fields.
ID of an active employee user to use as sender.
Array of recipient objects. Either this or contact_list_id must be provided when creating a single email. If not provided, a contact list will be created automatically.
ID of an existing contact list. Either this or recipients must be provided when creating a single email.
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
MAILSOFTLY_CREATE_OR_UPDATE_CONTACTTool to create a new contact or update an existing contact in Mailsoftly. Use when you need to add a new contact to the system or update an existing contact's information. If contact_id is provided, the existing contact will be updated; otherwise, a new contact will be created.
Input parameters
Email address of the contact. Required field.
Last name of the contact.
ID of the contact to update. If provided, updates the existing contact; otherwise creates a new one.
First name of the contact.
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
MAILSOFTLY_GET_CONTACTTool to retrieve a specific contact by ID from Mailsoftly. Use when you need to fetch details about a specific contact. You can choose between basic or detailed view using the type parameter.
Input parameters
Set to 'detailed' for detailed information, omit or leave empty for basic information.
ID of the contact to fetch.
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
MAILSOFTLY_GET_CONTACT_FIELDSTool to fetch all contact fields available for a firm, excluding hidden columns. Use when you need to retrieve the list of available contact field names and their data types.
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
MAILSOFTLY_GET_CONTACT_LISTTool to retrieve details of a specific contact list by ID. Use when you need to fetch information about a contact list including its name and contact count.
Input parameters
ID of the contact list to fetch
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
MAILSOFTLY_GET_CONTACT_LIST_CONTACTSTool to retrieve all contacts within a specific contact list. Use when you need to fetch the members of a particular contact list.
Input parameters
ID of the contact list to fetch contacts from.
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
MAILSOFTLY_GET_CONTACT_LISTSTool to retrieve all contact lists for the authenticated firm. Use when you need to view all available contact lists and their details.
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
MAILSOFTLY_GET_CONTACTSTool to retrieve all contacts associated with a firm. Use when you need to fetch the complete list of contacts from Mailsoftly.
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
MAILSOFTLY_GET_CUSTOM_FIELDSTool to retrieve all custom fields defined for the authenticated firm. Use when you need to understand what custom field options are available for contacts in Mailsoftly.
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
MAILSOFTLY_GET_EMAIL_STATUSTool to fetch the status of a specific email draft by its ID. Use when checking if a draft is ready to send or to get its current status.
Input parameters
ID of the email draft to check status for.
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
MAILSOFTLY_GET_TAGSTool to retrieve all tags associated with the authenticated firm. Use when you need to list available tags for organizing contacts or campaigns.
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
MAILSOFTLY_SEARCH_CONTACTSTool to search for contacts matching specified criteria in Mailsoftly. Use when you need to find contacts by email, first name, or last name. At least one search parameter should be provided for meaningful results.
Input parameters
Email address of the contact to search. Use for exact email matches.
Last name of the contact to search. Partial matches may be supported.
First name of the contact to search. Partial matches may be supported.
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
MAILSOFTLY_SEND_EMAILTool to send an existing email draft that is marked as ready. Use when you need to send a prepared email draft via Mailsoftly.
Input parameters
ID of the email draft to send. The draft must be marked as ready before it can be sent.
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
MAILSOFTLY_UPDATE_CONTACTTool to update an existing contact's information in Mailsoftly. Use when you need to modify contact details such as name or email address.
Input parameters
Email address of the contact.
Last name of the contact.
ID of the contact to update.
First name of the contact.
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 20 Mailsoftly actions on Nagent, including "Add Contact to Contact List", "Add Custom Field to Contact" and "Create Contact". Add Contact to Contact List: Add an existing contact to a specific contact list. Each action is listed on this page with its input parameters and its output.
Mailsoftly 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.
Add Contact to Contact List takes 2 required inputs: contact_id and contact_list_id. It returns data, error and successful.