NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Delighted connects to a Nagent workspace with an API key. Once it is connected, agents can call 13 Delighted actions, such as "Add Person to Autopilot Email", "Add Person to Autopilot SMS" and "Create or Update Person". 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 Delighted, with input parameters and output schema.
DELIGHTED_ADD_PERSON_TO_AUTOPILOT_EMAILAdd a person to Autopilot email or update their properties. Autopilot automatically schedules and sends recurring email surveys at the frequency configured in your Delighted account settings. Use this to enroll new people in automated email surveys or update custom properties for existing members. Note: Autopilot must be configured in your Delighted account before using this API.
Input parameters
Unique identifier for the person.
Custom key-value pairs to attach to Autopilot surveys. Supports custom fields for segmentation and special properties: question_product_name (customizes survey question, max 150 chars), delighted_email_subject (custom subject line, max 150 chars), delighted_intro_message (custom opening message, max 300 chars), locale (language/region like 'en', 'de', 'zh-CN'), thank_you_message, thank_you_link_text, thank_you_link_url (post-survey customization).
Person's name.
Email address of the person being added or updated. Required for email-based Autopilot surveys.
Phone number in E.164 format (e.g., +17132746524).
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
DELIGHTED_ADD_PERSON_TO_AUTOPILOT_SMSTool to add a person to Autopilot or update their properties for SMS-based surveys. Use when you need to schedule automated survey delivery via SMS. Prerequisites: SMS Autopilot must be configured in your Delighted account before using this API endpoint. If not configured, the API returns a 422 error.
Input parameters
Unique identifier for the person.
Custom properties for surveys. Can include special properties like question_product_name, delighted_email_subject, delighted_intro_message, locale, thank_you_message, thank_you_link_text, and thank_you_link_url.
Person's name.
Email address of the person.
Phone number in E.164 format (e.g., +17132746524). Must start with +, contain country code, and use only + and digits.
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
DELIGHTED_CREATE_PERSONTool to create or update a person and schedule a survey email. Use when you need to add a new person to Delighted, update existing person details, or schedule a survey with custom properties for segmentation.
Input parameters
Name of the person.
Whether to send the survey. Set to false to create/update person without scheduling survey delivery. Default is true.
Number of seconds to wait before sending the survey. Default is 0 (send immediately).
Email address of the person. Required if phone_number is not provided.
Communication channel for sending survey. Use 'sms' for SMS surveys or 'email' for email surveys (default).
Custom key-value pairs for segmentation and customization. Used for filtering and personalizing surveys.
New email address when updating an existing contact.
Unix timestamp indicating when a survey was last sent to this person. Used to set previous survey send time.
Phone number in E.164 format (e.g., +17132746524). Required if channel is 'sms' or email is not provided.
New phone number in E.164 format when updating an existing 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
DELIGHTED_DELETE_PENDING_SURVEY_REQUESTSTool to remove all pending (scheduled but not yet sent) survey requests for a person. Use when you need to cancel all future surveys for a specific email address.
Input parameters
The email address of the person whose pending survey requests should be deleted
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
DELIGHTED_DELETE_PERSONTool to remove a person and all associated data from Delighted. Use when you need to permanently delete a person's information. Deletion includes surveys, responses, properties, Autopilot membership, survey history, and unsubscribe/bounce status.
Input parameters
Identifies the person to delete. Accepts three formats: 1) By ID: '24248363', 2) By Email: 'email:jony@appleseed.com', 3) By Phone Number: 'phone_number:+17132746524' (E.164 format)
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
DELIGHTED_GET_AUTOPILOT_EMAIL_CONFIGURATIONTool to retrieve the current Autopilot configuration for email distribution. Returns configuration details including whether Autopilot is active, survey frequency, and timestamps.
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
DELIGHTED_GET_AUTOPILOT_SMS_CONFIGURATIONTool to retrieve the current Autopilot configuration for SMS distribution. Use when you need to check whether Autopilot is enabled, review survey frequency settings, or examine configuration timestamps for SMS surveys.
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
DELIGHTED_LIST_AUTOPILOT_SMS_MEMBERSHIPSTool to retrieve all Autopilot memberships for SMS distribution platform. Use when you need to list people enrolled in Autopilot SMS or filter by specific person details.
Input parameters
Number of results per page. Default is 20, maximum is 100.
Filter results to a specific person by ID.
Filter results to a specific person by email address.
Filter results to a specific person by phone number in E.164 format (e.g., +17132746524).
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
DELIGHTED_LIST_BOUNCED_PEOPLETool to retrieve all bounced people for your account, ordered by bounce time (oldest first). Use when you need to identify email addresses that have bounced. Supports pagination via per_page and page parameters, and optional Unix timestamp filters (since, until) to restrict results to specific time ranges.
Input parameters
Page number to retrieve (default: 1).
Unix timestamp filtering bounces on or after this date.
Unix timestamp filtering bounces on or before this date.
Number of results per page (default: 20, max: 100).
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
DELIGHTED_LIST_PEOPLETool to retrieve all people for your account in creation order. Use when you need to list contacts, filter by email or phone number, or paginate through your people database. Supports cursor-based pagination via Link header and optional time-based filtering. Note: email and phone_number filters are mutually exclusive.
Input parameters
Filter results to a specific person by email address. Mutually exclusive with phone_number.
Unix timestamp to filter people created on or after this time.
Unix timestamp to filter people created on or before this time.
Number of results per page. Default is 20, maximum is 100.
Cursor token for pagination. Use the next_page_info value from a previous response to retrieve the next page of results.
Filter results by phone number in E.164 format (e.g., '+17132746524'). Mutually exclusive with 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
DELIGHTED_LIST_SURVEY_RESPONSESTool to retrieve all survey responses for your account with pagination support and optional filtering. Use when you need to access survey feedback data, filter by date range, trend, person, or sort by creation/update time. Supports expanding person details and notes.
Input parameters
Page number to retrieve (default: 1).
Sort order for responses based on creation or update time. Accepts 'asc' (default), 'desc', 'asc:updated_at', or 'desc:updated_at'.
Unix timestamp restricting responses to those created on or after this time.
ID of a trend to filter responses by that specific trend.
Unix timestamp restricting responses to those created on or before this time.
Array specifying objects to expand. Supports 'person' and 'notes'.
Number of results per page (default: 20, max: 100).
ID restricting responses to a specific person.
Email address restricting responses to a specific person.
Unix timestamp restricting responses to those updated on or after this time.
Unix timestamp restricting responses to those updated on or before this time.
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
DELIGHTED_LIST_UNSUBSCRIBED_PEOPLETool to retrieve all unsubscribed people for your account, ordered by unsubscribe time (oldest first). Use when you need to identify people who have unsubscribed. Supports pagination via per_page and page parameters, and optional Unix timestamp filters (since, until) to restrict results to specific time ranges.
Input parameters
Page number to retrieve (default: 1).
Unix timestamp filtering unsubscribes on or after this date.
Unix timestamp filtering unsubscribes on or before this date.
Number of results per page (default: 20, max: 100).
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
DELIGHTED_UNSUBSCRIBE_PERSONTool to add a person to your unsubscribe list, preventing them from receiving any future surveys via email. Use when you need to permanently unsubscribe someone from all email surveys. This is functionally equivalent to the person clicking Unsubscribe within a survey.
Input parameters
The email address of the person to unsubscribe from surveys
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 13 Delighted actions on Nagent, including "Add Person to Autopilot Email", "Add Person to Autopilot SMS" and "Create or Update Person". Add Person to Autopilot Email: Add a person to Autopilot email or update their properties. Each action is listed on this page with its input parameters and its output.
Delighted 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 Person to Autopilot Email takes 1 required input: person_email. It also takes 4 optional inputs: person_id, properties, person_name and person_phone_number. It returns data, error and successful.