Unisender
unisenderUniSender is a simple and easy-to-use service for email and SMS marketing campaigns
Acciones disponibles (33)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Check Email StatusUNISENDER_CHECK_EMAILAcciónTool 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.
UNISENDER_CHECK_EMAILAcciónTool 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.
Parámetros de entrada
email_idinteger[]ObligatorioOne 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Email TemplateUNISENDER_CREATE_EMAIL_TEMPLATEAcciónTool 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.
UNISENDER_CREATE_EMAIL_TEMPLATEAcciónTool 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.
Parámetros de entrada
tagstringTags for organizing and categorizing templates. Optional parameter.
bodystringHTML body content of the email template. Supports HTML markup and template variables like {{to_name}}.
langstringLanguage code for the template (e.g., 'en', 'ru', 'de'). Affects system messages.
titlestringObligatorioThe title/name of the email template. Required parameter.
subjectstringEmail subject line for the template. Optional parameter.
text_bodystringPlain text version of the email body. Optional parameter.
sender_namestringName of the sender that will appear in the email. Optional parameter.
sender_emailstringEmail address of the sender. Optional parameter.
generate_textintegerAuto-generate plain text version from HTML body. Set to 1 to enable, 0 to disable.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create FieldUNISENDER_CREATE_FIELDAcciónTool 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.
UNISENDER_CREATE_FIELDAcciónTool 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.
Parámetros de entrada
namestringObligatorioThe internal name of the field. This is the identifier used in API calls and must be unique.
field_typestringObligatorioenumThe data type of the field. Possible values: 'string' (short text), 'text' (long text), 'number' (numeric), 'date' (date), 'bool' (boolean).
stringtextnumberdatebool
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ListUNISENDER_CREATE_LISTAcciónTool 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.
UNISENDER_CREATE_LISTAcciónTool 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.
Parámetros de entrada
titlestringObligatorioThe name/title of the contact list. Must be unique within the account.
after_subscribe_urlstringURL to redirect subscribers after successful subscription. Shows a message that the subscription has been completed successfully.
before_subscribe_urlstringURL to redirect subscribers before subscription confirmation. Shows a message that the contact should follow the confirmation link to activate the subscription.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Subscriber NoteUNISENDER_CREATE_SUBSCRIBER_NOTEAcciónTool 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'.
UNISENDER_CREATE_SUBSCRIBER_NOTEAcciónTool 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'.
Parámetros de entrada
contentstringObligatorioThe text content of the note to be created. This will be stored as a note associated with the subscriber.
subscriber_idintegerObligatorioThe ID of the subscriber/contact to attach the note to. This is the unique identifier of the subscriber in UniSender.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete FieldUNISENDER_DELETE_FIELDAcciónTool 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.
UNISENDER_DELETE_FIELDAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the custom field to be deleted. This will remove the field and all associated contact data.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ListUNISENDER_DELETE_LISTAcciónTool to permanently delete a contact list from your UniSender account. Use when you need to remove a mailing list by its ID.
UNISENDER_DELETE_LISTAcciónTool to permanently delete a contact list from your UniSender account. Use when you need to remove a mailing list by its ID.
Parámetros de entrada
list_idintegerObligatorioThe unique identifier of the contact list to be deleted. This will permanently remove the list from your UniSender account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Subscriber NoteUNISENDER_DELETE_SUBSCRIBER_NOTEAcciónTool 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.
UNISENDER_DELETE_SUBSCRIBER_NOTEAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the note to be deleted.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TagUNISENDER_DELETE_TAGAcciónTool 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.
UNISENDER_DELETE_TAGAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe numeric identifier of the tag to be deleted. Once deleted, the tag will be removed from all associated contacts.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TemplateUNISENDER_DELETE_TEMPLATEAcciónTool to remove a template from the UniSender account. Use when you need to permanently delete a template by its ID.
UNISENDER_DELETE_TEMPLATEAcciónTool to remove a template from the UniSender account. Use when you need to permanently delete a template by its ID.
Parámetros de entrada
template_idintegerObligatorioThe unique identifier of the template to be deleted. Once deleted, the template cannot be recovered.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Exclude Contact from ListsUNISENDER_EXCLUDEAcciónTool 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.
UNISENDER_EXCLUDEAcciónTool 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.
Parámetros de entrada
contactstringObligatorioEmail address or phone number of the contact to exclude from lists.
list_idsstringComma-separated list IDs from which the contact will be excluded. If not provided, the contact will be excluded from all lists.
contact_typestringenumType of contact being excluded. Must be either 'email' or 'phone'. Defaults to 'email' if not specified.
emailphone
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export ContactsUNISENDER_EXPORT_CONTACTSAcciónTool to export contact data from UniSender lists for synchronization. Use when you need to export email addresses, phone numbers, and custom fields from lists. This method works asynchronously - the response contains a task_uuid for tracking export status.
UNISENDER_EXPORT_CONTACTSAcciónTool to export contact data from UniSender lists for synchronization. Use when you need to export email addresses, phone numbers, and custom fields from lists. This method works asynchronously - the response contains a task_uuid for tracking export status.
Parámetros de entrada
tagstringFilter contacts by tag.
emailstringEmail address. If specified, result will contain only one contact with this email.
limitintegerMaximum number of contacts to return. Defaults to 1000.
phonestringPhone number. If specified, result will contain only one contact with this phone.
offsetintegerPagination offset. Defaults to 0.
list_idintegerExport list code. If not specified, all lists will be exported. Codes can be obtained via getLists method.
notify_urlstringURL to which the response will be sent after the report is generated.
field_namesstring[]Array of field names to export. Defaults to ['email']. If absent, all possible fields are exported.
email_statusstringFilter by email status. Options: 'active', 'activation_requested', 'blocked'.
phone_statusstringFilter by phone status. Options: 'active', 'blocked', 'inactive'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CampaignsUNISENDER_GET_CAMPAIGNSAcciónTool 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.
UNISENDER_GET_CAMPAIGNSAcciónTool 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.
Parámetros de entrada
tostringEnd 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.
fromstringStart 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.
limitintegerNumber of records to return in the response. Maximum 10,000.
offsetintegerOffset from which position the selection is to be started for pagination.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign StatusUNISENDER_GET_CAMPAIGN_STATUSAcciónTool to check the current status of a campaign in UniSender. Use when you need to verify campaign progress or completion status. Returns detailed status information including creation time and start time.
UNISENDER_GET_CAMPAIGN_STATUSAcciónTool to check the current status of a campaign in UniSender. Use when you need to verify campaign progress or completion status. Returns detailed status information including creation time and start time.
Parámetros de entrada
campaign_idintegerObligatorioThe ID of the campaign whose status you want to check. This ID is obtained when creating a campaign.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactUNISENDER_GET_CONTACTAcciónTool 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.
UNISENDER_GET_CONTACTAcciónTool 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.
Parámetros de entrada
emailstringThe contact's email address to search for. Either email or contact_id must be provided.
contact_idintegerThe contact's unique ID in UniSender. Either email or contact_id must be provided.
include_listsintegerSet to 1 to include list membership information with subscription status.
include_fieldsintegerSet to 1 to include custom field values for the contact.
include_detailsintegerSet to 1 to include additional detailed contact statistics.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact Field ValuesUNISENDER_GET_CONTACT_FIELD_VALUESAcciónTool to retrieve custom field values for a specific contact identified by email address. Use when you need to get additional field data associated with a contact. You can optionally specify which fields to retrieve by providing field IDs.
UNISENDER_GET_CONTACT_FIELD_VALUESAcciónTool to retrieve custom field values for a specific contact identified by email address. Use when you need to get additional field data associated with a contact. You can optionally specify which fields to retrieve by providing field IDs.
Parámetros de entrada
emailstringObligatorioThe email address of the contact whose field values you want to retrieve.
field_idsstringObligatorioComma-separated list of field IDs to retrieve values for (e.g., '1,2,5'). This parameter is required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get FieldsUNISENDER_GET_FIELDSAcciónTool 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.
UNISENDER_GET_FIELDSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ListsUNISENDER_GET_LISTSAcciónTool 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.
UNISENDER_GET_LISTSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get MessagesUNISENDER_GET_MESSAGESAcciónTool to retrieve list of all messages with body and attachments. Use when you need complete message information including content and attachments, unlike listMessages which returns only metadata.
UNISENDER_GET_MESSAGESAcciónTool to retrieve list of all messages with body and attachments. Use when you need complete message information including content and attachments, unlike listMessages which returns only metadata.
Parámetros de entrada
limitintegerMaximum number of messages to return. Default is 30. Used for pagination.
offsetintegerNumber of messages to skip for pagination. Must be non-negative. Default is 0.
date_tostringObligatorioEnd date/time for filtering messages by creation date. Format: YYYY-MM-DD HH:MM or ISO 8601.
date_fromstringObligatorioStart date/time for filtering messages by creation date. Format: YYYY-MM-DD HH:MM or ISO 8601.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sender Domain ListUNISENDER_GET_SENDER_DOMAIN_LISTAcciónTool 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.
UNISENDER_GET_SENDER_DOMAIN_LISTAcciónTool 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.
Parámetros de entrada
usernamestringObligatorioUsername for which to retrieve sender domain information.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TagsUNISENDER_GET_TAGSAcciónTool to retrieve all custom tags/labels for contact segmentation. Use when you need to list all available tags in the Unisender account.
UNISENDER_GET_TAGSAcciónTool to retrieve all custom tags/labels for contact segmentation. Use when you need to list all available tags in the Unisender account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplateUNISENDER_GET_TEMPLATEAcciónTool 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.
UNISENDER_GET_TEMPLATEAcciónTool 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.
Parámetros de entrada
template_idintegerObligatorioThe unique identifier of the template to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplatesUNISENDER_GET_TEMPLATESAcciónTool to retrieve list of all templates with full content including body. Use when you need complete template information including raw_body and body fields, unlike listTemplates which returns templates without body content.
UNISENDER_GET_TEMPLATESAcciónTool to retrieve list of all templates with full content including body. Use when you need complete template information including raw_body and body fields, unlike listTemplates which returns templates without body content.
Parámetros de entrada
typestringTemplate type filter. Use 'system' for system templates, 'user' for user-created templates.
limitintegerNumber of templates to display in one request.
offsetintegerPosition from which the list of templates will be displayed for this request.
date_tostringEnd date/time for filtering templates. Format: YYYY-MM-DD HH:MM (e.g., '2015-12-14 12:00').
date_fromstringStart date/time for filtering templates. Format: YYYY-MM-DD HH:MM (e.g., '2015-12-14 12:00').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import Contacts (Bulk)UNISENDER_IMPORT_CONTACTSAcciónTool 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.
UNISENDER_IMPORT_CONTACTSAcciónTool 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.
Parámetros de entrada
dataarray[]ObligatorioMultidimensional 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.
field_namesstring[]ObligatorioArray 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.
overwrite_tagsintegerenumControls how to handle existing tags. 0 = add to existing tags (default), 1 = replace all existing tags with new ones.
01overwrite_listsintegerenumControls how to handle existing list subscriptions. 0 = add to existing lists (default), 1 = replace all existing list subscriptions with new ones.
01
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Check if Contact is in ListsUNISENDER_IS_CONTACT_IN_LISTSAcciónTool 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).
UNISENDER_IS_CONTACT_IN_LISTSAcciónTool 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).
Parámetros de entrada
emailstringObligatorioThe email address of the contact to check. This is used to identify the contact in the system.
list_idsstringObligatorioComma-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.
conditionstringenumLogic 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'.
andor
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List MessagesUNISENDER_LIST_MESSAGESAcciónTool to list all messages without body and attachments. Use when you need to browse available messages created via API or web interface.
UNISENDER_LIST_MESSAGESAcciónTool to list all messages without body and attachments. Use when you need to browse available messages created via API or web interface.
Parámetros de entrada
limitintegerMaximum number of messages to return. Default is 30.
offsetintegerNumber of messages to skip for pagination. Must be non-negative. Default is 0.
date_tostringEnd date for filtering messages by creation date. Format: YYYY-MM-DD HH:MM:SS or ISO 8601.
date_fromstringStart date for filtering messages by creation date. Format: YYYY-MM-DD HH:MM:SS or ISO 8601.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TemplatesUNISENDER_LIST_TEMPLATESAcciónTool to list email templates without body content. Use when you need to browse available templates created via API or web interface.
UNISENDER_LIST_TEMPLATESAcciónTool to list email templates without body content. Use when you need to browse available templates created via API or web interface.
Parámetros de entrada
tostringEnd date for filtering templates by creation date (ISO format, e.g., '2024-12-31').
fromstringStart date for filtering templates by creation date (ISO format, e.g., '2024-01-01').
typestringFilter by template type (e.g., 'system' for system templates).
limitintegerMaximum number of templates to return. Default is 50.
offsetintegerNumber of templates to skip for pagination. Default is 0.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Subscribe Contact to ListsUNISENDER_SUBSCRIBEAcciónTool to add contacts to one or multiple mailing lists with optional tags and field values. Use when you need to subscribe a contact (email and/or phone) to Unisender lists. This method adds contacts individually and can override existing contact data based on the overwrite parameter. Contacts previously excluded can be re-added using this action.
UNISENDER_SUBSCRIBEAcciónTool to add contacts to one or multiple mailing lists with optional tags and field values. Use when you need to subscribe a contact (email and/or phone) to Unisender lists. This method adds contacts individually and can override existing contact data based on the overwrite parameter. Contacts previously excluded can be re-added using this action.
Parámetros de entrada
namestringContact's name. This will be stored in the Name field of the contact.
tagsstringComma-separated tags to assign to the contact for segmentation purposes (e.g., 'newsletter,premium'). Tags help organize and filter contacts.
emailstringObligatorioContact's email address. This is the primary identifier for the contact.
phonestringContact's phone number. Can be mobile or landline.
list_idsstringObligatorioComma-separated list of mailing list IDs to subscribe the contact to (e.g., '123,456'). The contact will be added to all specified lists.
overwriteintegerenumControls 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.
012confirm_ipstringIP address from which the subscription was confirmed. Used for tracking purposes.
request_ipstringIP address from which the subscription request originated. Used for tracking purposes.
confirm_timestringTimestamp when the subscription was confirmed. Format: YYYY-MM-DD HH:MM:SS or Unix timestamp.
double_optinintegerenumControls 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.
34request_timestringTimestamp when the subscription request was made. Format: YYYY-MM-DD HH:MM:SS or Unix timestamp.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unsubscribe ContactUNISENDER_UNSUBSCRIBEAcciónTool 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.
UNISENDER_UNSUBSCRIBEAcciónTool 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.
Parámetros de entrada
contactstringObligatorioEmail address or phone number that needs to be unsubscribed from campaigns.
list_idsstringComma-separated list IDs from which the contact will be unsubscribed. If not provided, the contact will be unsubscribed from all lists.
contact_typestringObligatorioenumType of contact being unsubscribed. Must be either 'email' or 'phone'.
emailphone
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Email TemplateUNISENDER_UPDATE_EMAIL_TEMPLATEAcciónTool 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.
UNISENDER_UPDATE_EMAIL_TEMPLATEAcciónTool 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.
Parámetros de entrada
bodystringHTML body content of the email template. Only updated if provided.
langstringLanguage code for the template (e.g., 'en', 'de', 'fr', 'it', 'ru'). Only updated if provided.
titlestringNew title/name for the template. Only updated if provided.
list_idintegerID of the mailing list associated with template. Only updated if provided.
subjectstringEmail subject line. Only updated if provided.
text_bodystringPlain text version of the email body. Only updated if provided.
wrap_typestringText wrapping type for the template. Only updated if provided.
categoriesstringTemplate categories/tags. Only updated if provided.
sender_namestringName of the sender. Only updated if provided.
template_idintegerObligatorioThe ID of the template to update. Required parameter.
sender_emailstringEmail address of the sender. Only updated if provided.
generate_textintegerAuto-generate text version from HTML body. Set to 1 to enable, 0 to disable. Only applied if provided.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update FieldUNISENDER_UPDATE_FIELDAcciónTool 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.
UNISENDER_UPDATE_FIELDAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe ID of the field to update. This identifies which custom field should be modified.
namestringObligatorioThe new name for the field. This is the internal identifier used in API calls.
view_posintegerControls the position/order where the field appears in views. Default is 1.
field_typestringThe data type of the field. Valid values: string, number, date, text, bool.
is_visibleintegerControls field visibility. Set to 1 for visible (default) or 0 to hide the field.
public_namestringThe public display name for the field that will be shown in the user interface.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ListUNISENDER_UPDATE_LISTAcciónTool to update the parameters of an existing contact list in UniSender. Use when you need to change the title, pre-subscription URL, or post-subscription URL of an existing mailing list.
UNISENDER_UPDATE_LISTAcciónTool to update the parameters of an existing contact list in UniSender. Use when you need to change the title, pre-subscription URL, or post-subscription URL of an existing mailing list.
Parámetros de entrada
titlestringObligatorioThe new title/name for the mailing list. This will replace the existing list name.
list_idintegerObligatorioThe ID of the list to update. This identifies which contact list should be modified.
after_subscribe_urlstringThe 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).
before_subscribe_urlstringThe 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).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Subscriber NoteUNISENDER_UPDATE_SUBSCRIBER_NOTEAcciónTool 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.
UNISENDER_UPDATE_SUBSCRIBER_NOTEAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe identifier of the note to be edited. This is the unique ID of the subscriber note you want to update.
contentstringObligatorioThe new content for the note. This will replace the existing note content.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not