Skip to main content
Unisender logo
  • Category: marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 33
  • Triggers: 0
  • Slug: UNISENDER
  • Version: 20261101_00

Tools

Slug: UNISENDER_CHECK_EMAILTool to check the delivery status of emails sent via sendEmail method. Use when you need to verify email delivery status by email IDs. Statuses are stored for approximately one month. Rate limited to 300 requests per 60 seconds.

Input Parameters

array
required
One or more email IDs to check delivery status for. These are the email_id values returned by the sendEmail method. Provide as a list of integers.

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: UNISENDER_CREATE_EMAIL_TEMPLATETool to create a new email template for mass campaigns in UniSender. Use when you need to create a reusable email template with customizable title, subject, body content, and sender information.

Input Parameters

string
Tags for organizing and categorizing templates. Optional parameter.
string
HTML body content of the email template. Supports HTML markup and template variables like {{to_name}}.
string
Language code for the template (e.g., ‘en’, ‘ru’, ‘de’). Affects system messages.
string
required
The title/name of the email template. Required parameter.
string
Email subject line for the template. Optional parameter.
string
Plain text version of the email body. Optional parameter.
string
Name of the sender that will appear in the email. Optional parameter.
string
Email address of the sender. Optional parameter.
integer
Auto-generate plain text version from HTML body. Set to 1 to enable, 0 to disable.

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: UNISENDER_CREATE_FIELDTool to create a new custom field for contact data in UniSender. Use when you need to add a custom field that can store additional contact information and be used in email message substitutions.

Input Parameters

string
required
The internal name of the field. This is the identifier used in API calls and must be unique.
string ("string" | "text" | "number" | "date" | "bool")
required
The data type of the field. Possible values: ‘string’ (short text), ‘text’ (long text), ‘number’ (numeric), ‘date’ (date), ‘bool’ (boolean).

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: UNISENDER_CREATE_LISTTool to create a new contact list for organizing thematic email campaigns in UniSender. Use when you need to create a new mailing list with a unique title. The list title must be unique within the account.

Input Parameters

string
required
The name/title of the contact list. Must be unique within the account.
string
URL to redirect subscribers after successful subscription. Shows a message that the subscription has been completed successfully.
string
URL to redirect subscribers before subscription confirmation. Shows a message that the contact should follow the confirmation link to activate the subscription.

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: UNISENDER_CREATE_SUBSCRIBER_NOTETool to create a note for a subscriber contact in UniSender. Use when you need to add a new note to a subscriber’s profile. Notes created via API have an ‘origin’ field set to ‘api’.

Input Parameters

string
required
The text content of the note to be created. This will be stored as a note associated with the subscriber.
integer
required
The ID of the subscriber/contact to attach the note to. This is the unique identifier of the subscriber in UniSender.

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: UNISENDER_DELETE_FIELDTool to remove a custom field from the Unisender system. Use when you need to permanently delete a custom field and all its associated contact data.

Input Parameters

integer
required
The unique identifier of the custom field to be deleted. This will remove the field and all associated contact data.

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: UNISENDER_DELETE_LISTTool to permanently delete a contact list from your UniSender account. Use when you need to remove a mailing list by its ID.

Input Parameters

integer
required
The unique identifier of the contact list to be deleted. This will permanently remove the list from your UniSender account.

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: UNISENDER_DELETE_SUBSCRIBER_NOTETool to delete a subscriber note from UniSender by its ID. Use when you need to remove a note associated with a subscriber/contact from the system.

Input Parameters

integer
required
The unique identifier of the note to be deleted.

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: UNISENDER_DELETE_TAGTool to delete a tag by its ID and remove it from all associated contacts. Use when you need to remove a tag from your UniSender account.

Input Parameters

integer
required
The numeric identifier of the tag to be deleted. Once deleted, the tag will be removed from all associated contacts.

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: UNISENDER_DELETE_TEMPLATETool to remove a template from the UniSender account. Use when you need to permanently delete a template by its ID.

Input Parameters

integer
required
The unique identifier of the template to be deleted. Once deleted, the template cannot be recovered.

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: UNISENDER_EXCLUDETool to remove contacts from specified lists or all lists in UniSender. Use when you need to exclude a contact (email or phone) from mailing lists. Unlike unsubscribe, exclude actually removes the contact from lists, allowing them to be re-added later using the subscribe method. Recommended when subscription management is performed by sender’s initiative.

Input Parameters

string
required
Email address or phone number of the contact to exclude from lists.
string
Comma-separated list IDs from which the contact will be excluded. If not provided, the contact will be excluded from all lists.
string ("email" | "phone")
Type of contact being excluded. Must be either ‘email’ or ‘phone’. Defaults to ‘email’ if not specified.

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: UNISENDER_EXPORT_CONTACTSStart an asynchronous export of contact data from UniSender lists for synchronization, including email addresses, phone numbers, and custom fields. The response may contain a task UUID for tracking export status.

Input Parameters

string
Filter contacts by tag.
string
Email address. If specified, result will contain only one contact with this email.
integer
Maximum number of contacts to return. Defaults to 1000.
string
Phone number. If specified, result will contain only one contact with this phone.
integer
Pagination offset. Defaults to 0.
integer
Export list code. If not specified, all lists will be exported. Codes can be obtained via getLists method.
string
URL to which the response will be sent after the report is generated.
array
Array of field names to export. Defaults to [‘email’]. If absent, all possible fields are exported.
string
Filter by email status. Options: ‘active’, ‘activation_requested’, ‘blocked’.
string
Filter by phone status. Options: ‘active’, ‘blocked’, ‘inactive’.

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: UNISENDER_GET_CAMPAIGNSTool to retrieve list of campaigns from Unisender within a specified date range. Use when you need to fetch email campaign information with optional filtering by date and pagination support. Returns up to 10,000 campaigns per request.

Input Parameters

string
End time of the campaign until which campaigns are to be displayed. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS or Unix timestamp.
string
Start time of the campaign from which campaigns are to be displayed. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS or Unix timestamp.
integer
Number of records to return in the response. Maximum 10,000.
integer
Offset from which position the selection is to be started for pagination.

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: UNISENDER_GET_CAMPAIGN_STATUSCheck the current status of a campaign in UniSender to verify its progress or completion. The response may include creation and start times.

Input Parameters

integer
required
The ID of the campaign whose status you want to check. This ID is obtained when creating a campaign.

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: UNISENDER_GET_CONTACTTool to get information about a single contact from UniSender. Use when you need to retrieve detailed contact data including email/phone status, custom fields, list memberships, and engagement statistics. Either email or contact_id must be provided.

Input Parameters

string
The contact’s email address to search for. Either email or contact_id must be provided.
integer
The contact’s unique ID in UniSender. Either email or contact_id must be provided.
integer
Set to 1 to include list membership information with subscription status.
integer
Set to 1 to include custom field values for the contact.
integer
Set to 1 to include additional detailed contact statistics.

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: UNISENDER_GET_CONTACT_FIELD_VALUESRetrieve custom field values for a contact identified by email address, for the specified field IDs.

Input Parameters

string
required
The email address of the contact whose field values you want to retrieve.
string
required
Comma-separated list of field IDs to retrieve values for (e.g., ‘1,2,5’). This parameter is required.

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: UNISENDER_GET_FIELDSTool to retrieve all custom user-defined fields for contact personalization and data management. Use when creating integrations to map fields between systems or to retrieve available custom fields for contacts.

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: UNISENDER_GET_LISTSTool to retrieve all existing mailing lists associated with the account. Use when you need to get list IDs and titles before sending emails or SMS to a list, or to display available contact lists.

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: UNISENDER_GET_MESSAGESRetrieve messages within a required creation-date range, including message bodies and any available attachments. Supports pagination.

Input Parameters

integer
Maximum number of messages to return. Default is 30. Used for pagination.
integer
Number of messages to skip for pagination. Must be non-negative. Default is 0.
string
required
End date/time for filtering messages by creation date. Format: YYYY-MM-DD HH:MM or ISO 8601.
string
required
Start date/time for filtering messages by creation date. Format: YYYY-MM-DD HH:MM or ISO 8601.

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: UNISENDER_GET_SENDER_DOMAIN_LISTTool to retrieve information about sender domains and their DKIM status. Use when you need to check which domains are registered for sending emails and their verification status.

Input Parameters

string
required
Username for which to retrieve sender domain information.

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: UNISENDER_GET_TAGSTool to retrieve all custom tags/labels for contact segmentation. Use when you need to list all available tags in the Unisender account.

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: UNISENDER_GET_TEMPLATETool to retrieve detailed information about a specific email template by its ID. Use when you need to fetch template details including metadata, content, creation details, and formatting information.

Input Parameters

integer
required
The unique identifier of the template to retrieve.

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: UNISENDER_GET_TEMPLATESRetrieve templates with their available details, including body and raw body content for user templates. Supports filtering and pagination.

Input Parameters

string
Template type filter. Use ‘system’ for system templates, ‘user’ for user-created templates.
integer
Number of templates to display in one request.
integer
Position from which the list of templates will be displayed for this request.
string
End date/time for filtering templates. Format: YYYY-MM-DD HH:MM (e.g., ‘2015-12-14 12:00’).
string
Start date/time for filtering templates. Format: YYYY-MM-DD HH:MM (e.g., ‘2015-12-14 12:00’).

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: UNISENDER_IMPORT_CONTACTSTool to bulk import contacts to UniSender with maximum 500 contacts per call. Use when you need to import multiple contacts at once with their fields, list subscriptions, and tags. Supports creating new contacts, updating existing ones, and managing list subscriptions. UniSender automatically validates emails and filters spam-traps.

Input Parameters

array
required
Multidimensional array of contact data. Each inner array represents one contact, with values corresponding to field_names array. Maximum 500 contacts per call. For email_list_ids field, use comma-separated list IDs (e.g., ‘123,456’). For tags field, use comma-separated tags.
array
required
Array of field names for the data being imported. Standard fields: ‘email’, ‘phone’, ‘email_list_ids’, ‘tags’. Custom fields can be any user-defined field names (max 50 fields). The order must match the order of values in each data row.
integer ("0" | "1")
Controls how to handle existing tags. 0 = add to existing tags (default), 1 = replace all existing tags with new ones.
integer ("0" | "1")
Controls how to handle existing list subscriptions. 0 = add to existing lists (default), 1 = replace all existing list subscriptions with new ones.

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: UNISENDER_IS_CONTACT_IN_LISTSTool to check if a contact exists in specified mailing lists based on and/or conditions. Use when you need to verify whether a contact is a member of specific lists. The condition parameter allows checking if the contact is in all lists (and) or at least one list (or).

Input Parameters

string
required
The email address of the contact to check. This is used to identify the contact in the system.
string
required
Comma-separated list of mailing list IDs to check the contact against (e.g., ‘1,3,4’). The contact will be checked for membership in these lists.
string ("and" | "or")
Logic condition for checking multiple lists. Use ‘or’ if the contact must be in at least one list, or ‘and’ if the contact must be in all specified lists. Defaults to ‘or’.

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: UNISENDER_LIST_MESSAGESTool to list all messages without body and attachments. Use when you need to browse available messages created via API or web interface.

Input Parameters

integer
Maximum number of messages to return. Default is 30.
integer
Number of messages to skip for pagination. Must be non-negative. Default is 0.
string
End date for filtering messages by creation date. Format: YYYY-MM-DD HH:MM:SS or ISO 8601.
string
Start date for filtering messages by creation date. Format: YYYY-MM-DD HH:MM:SS or ISO 8601.

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: UNISENDER_LIST_TEMPLATESTool to list email templates without body content. Use when you need to browse available templates created via API or web interface.

Input Parameters

string
End date for filtering templates by creation date (ISO format, e.g., ‘2024-12-31’).
string
Start date for filtering templates by creation date (ISO format, e.g., ‘2024-01-01’).
string
Filter by template type (e.g., ‘system’ for system templates).
integer
Maximum number of templates to return. Default is 50.
integer
Number of templates to skip for pagination. Default is 0.

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: UNISENDER_SUBSCRIBESubscribe one contact, identified by email, to one or more UniSender lists, with optional phone, name, tags and subscription settings. Existing contact data can be overwritten according to the overwrite setting; previously excluded contacts can be re-added.

Input Parameters

string
Contact’s name. This will be stored in the Name field of the contact.
string
Comma-separated tags to assign to the contact for segmentation purposes (e.g., ‘newsletter,premium’). Tags help organize and filter contacts.
string
required
Contact’s email address. This is the primary identifier for the contact.
string
Contact’s phone number. Can be mobile or landline.
string
required
Comma-separated list of mailing list IDs to subscribe the contact to (e.g., ‘123,456’). The contact will be added to all specified lists.
integer ("0" | "1" | "2")
Controls how existing contact data should be handled. 0: do not overwrite existing fields, 1: overwrite all existing fields with new values, 2: overwrite only empty fields.
string
IP address from which the subscription was confirmed. Used for tracking purposes.
string
IP address from which the subscription request originated. Used for tracking purposes.
string
Timestamp when the subscription was confirmed. Format: YYYY-MM-DD HH:MM:SS or Unix timestamp.
integer ("3" | "4")
Controls subscription confirmation behavior. If not specified, sends confirmation email. Use 3 to bypass email verification (add without confirmation), or 4 to send confirmation only for new contacts.
string
Timestamp when the subscription request was made. Format: YYYY-MM-DD HH:MM:SS or Unix timestamp.

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: UNISENDER_UNSUBSCRIBETool to unsubscribe contacts from mailing lists in UniSender. Use when a contact initiates opt-out from campaigns. This marks contacts as ‘unsubscribed’ rather than excluding them - the active status can only be restored by the contact clicking an activation link.

Input Parameters

string
required
Email address or phone number that needs to be unsubscribed from campaigns.
string
Comma-separated list IDs from which the contact will be unsubscribed. If not provided, the contact will be unsubscribed from all lists.
string ("email" | "phone")
required
Type of contact being unsubscribed. Must be either ‘email’ or ‘phone’.

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: UNISENDER_UPDATE_EMAIL_TEMPLATETool to update an existing email template for mass campaigns. Use when you need to modify template properties like title, subject, body content, sender information, or language settings. Only the fields you specify will be updated.

Input Parameters

string
HTML body content of the email template. Only updated if provided.
string
Language code for the template (e.g., ‘en’, ‘de’, ‘fr’, ‘it’, ‘ru’). Only updated if provided.
string
New title/name for the template. Only updated if provided.
integer
ID of the mailing list associated with template. Only updated if provided.
string
Email subject line. Only updated if provided.
string
Plain text version of the email body. Only updated if provided.
string
Text wrapping type for the template. Only updated if provided.
string
Template categories/tags. Only updated if provided.
string
Name of the sender. Only updated if provided.
integer
required
The ID of the template to update. Required parameter.
string
Email address of the sender. Only updated if provided.
integer
Auto-generate text version from HTML body. Set to 1 to enable, 0 to disable. Only applied if provided.

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: UNISENDER_UPDATE_FIELDTool to modify parameters of an existing custom field in UniSender. Use when you need to change field properties like name, display name, type, visibility, or display position.

Input Parameters

integer
required
The ID of the field to update. This identifies which custom field should be modified.
string
required
The new name for the field. This is the internal identifier used in API calls.
integer
Controls the position/order where the field appears in views. Default is 1.
string
The data type of the field. Valid values: string, number, date, text, bool.
integer
Controls field visibility. Set to 1 for visible (default) or 0 to hide the field.
string
The public display name for the field that will be shown in the user interface.

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: UNISENDER_UPDATE_LISTUpdate a UniSender contact list by ID, supplying its title and optionally its pre-subscription and post-subscription URLs.

Input Parameters

string
required
The new title/name for the mailing list. This will replace the existing list name.
integer
required
The ID of the list to update. This identifies which contact list should be modified.
string
The URL for redirect to the post-subscription page. Usually this page shows a message that the subscription has been completed successfully. You can add substitution fields to this URL (e.g., email address or contact code).
string
The URL for redirect to the pre-subscription page. Usually this page shows a message that the contact should follow the confirmation link to activate the subscription. You can add substitution fields to this URL (e.g., email address or contact code).

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: UNISENDER_UPDATE_SUBSCRIBER_NOTETool to update the content of an existing subscriber note in UniSender. Use when you need to edit or modify the content of a previously created note attached to a subscriber.

Input Parameters

integer
required
The identifier of the note to be edited. This is the unique ID of the subscriber note you want to update.
string
required
The new content for the note. This will replace the existing note content.

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