Sender connects to a Nagent workspace with an API key. Once it is connected, agents can call 8 Sender actions, such as "Create Field", "Create Or Update Subscriber" and "Get All Fields". 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 Sender, with input parameters and output schema.
SENDER_CREATE_FIELDTool to create a new custom subscriber field in Sender.net. Use when you need to add custom fields for email personalization, segmentation, or storing additional subscriber information like company name, birthday, job title, or other custom attributes.
Input parameters
The data type of the field. Common types include 'text' for string values, 'number' for numeric values, 'date' for dates, and 'money' for currency values.
The display name/title of the custom field. This will be visible when managing subscriber data.
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
SENDER_CREATE_OR_UPDATE_SUBSCRIBERTool to create a new subscriber or update an existing one in Sender.net. Use when you need to add new subscribers to your email list or update existing subscriber information. This performs an upsert operation - creates if the email doesn't exist, updates if it does.
Input parameters
Subscriber's email address. This is required and will be used to identify existing subscribers.
Subscriber's phone number.
Custom fields object for additional subscriber attributes such as birthday, gender, location, company, title, or other relevant data.
Array of group IDs to assign the subscriber to.
Subscriber's last name.
Subscriber's first name.
Whether to trigger email automations for this subscriber. Default is true when not specified.
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
SENDER_GET_ALL_FIELDSTool to retrieve a list of all custom subscriber fields configured in the Sender.net account. Use when you need to view available fields for email personalization, segmentation, or managing subscriber data.
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
SENDER_GET_ALL_WORKFLOWSTool to retrieve a list of all automation workflows in the Sender account. Use when you need to view or manage automation workflows.
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
SENDER_GET_CAMPAIGN_BY_IDTool to retrieve a specific campaign by its unique ID from Sender. Use when you need detailed information about a campaign including delivery metrics and engagement statistics.
Input parameters
The unique identifier of the campaign to retrieve. Example: '1'
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
SENDER_GET_GROUP_BY_IDTool to retrieve a specific subscriber group by its unique ID from Sender. Use when you need detailed information about a single group including subscriber counts.
Input parameters
The unique identifier of the group to retrieve. Example: 'dBEVzJ'
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
SENDER_GET_SUBSCRIBER_BY_IDTool to retrieve a specific subscriber by their unique ID from Sender. Use when you need to fetch detailed information about a single subscriber including their status, groups, and custom fields.
Input parameters
The unique identifier of the subscriber to retrieve. Example: 'MJABNBP'
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
SENDER_UPDATE_SUBSCRIBER_FIELDSTool to update custom fields and information for an existing subscriber in Sender.net. Use when you need to modify subscriber details such as email, first name, last name, groups, or custom fields for email personalization and segmentation.
Input parameters
The subscriber's email address
Array of group IDs to assign the subscriber to
The subscriber's last name
The subscriber's first name
The unique identifier of the subscriber to update
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 8 Sender actions on Nagent, including "Create Field", "Create Or Update Subscriber" and "Get All Fields". Create Field: Create a new custom subscriber field in Sender.net. Each action is listed on this page with its input parameters and its output.
Sender 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 Field takes 2 required inputs: type and title. It returns data, error and successful.