Skip to main content
Mailsoftly logo
  • Category: email newsletters
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: MAILSOFTLY
  • Version: 20261101_00

Tools

Slug: 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

integer
required
ID of the existing contact to add to the contact list.
integer
required
ID of the contact list to add the contact to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contact to which the custom field will be added.
string
required
Name of the custom field to add.
string
required
Value of the custom field to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of tags to assign to the contact. Each tag must have a tag_name and tag_color.
integer
required
ID of the contact to assign tags to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSOFTLY_AUTHENTICATE_FIRMTool to validate the API key and retrieve firm details. Use when confirming credentials before making other Mailsoftly API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email address of the contact. This is required to create a contact.
string
Last name of the contact.
string
First name of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the contact list to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML content of the email body (required if not using mailLists).
string
Custom name for the email draft.
string
Subject line of the email draft (required if not using mailLists).
array
Array of attachment objects (maximum 5 attachments per email).
string
Email address for replies.
array
Array of email draft objects for creating multiple drafts at once. If provided, this takes precedence over individual subject/body/recipients fields.
integer
ID of an active employee user to use as sender.
array
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.
integer
ID of an existing contact list. Either this or recipients must be provided when creating a single email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email address of the contact. Required field.
string
Last name of the contact.
integer
ID of the contact to update. If provided, updates the existing contact; otherwise creates a new one.
string
First name of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILSOFTLY_GET_CONTACTRetrieve a Mailsoftly contact by ID, returning its ID, email, first name and last name. A basic or detailed view can be requested, but the response is limited to these fields.

Input Parameters

string
Set to ‘detailed’ for detailed information, omit or leave empty for basic information.
integer
required
ID of the contact to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contact list to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the contact list to fetch contacts from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the email draft to check status for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Email address of the contact to search. Use for exact email matches.
string
Last name of the contact to search. Partial matches may be supported.
string
First name of the contact to search. Partial matches may be supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the email draft to send. The draft must be marked as ready before it can be sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Email address of the contact.
string
Last name of the contact.
integer
required
ID of the contact to update.
string
First name of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not