Skip to main content
Delighted logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: DELIGHTED
  • Version: 20261101_00

Tools

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

string
Unique identifier for the person.
object
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).
string
Person’s name.
string
required
Email address of the person being added or updated. Required for email-based Autopilot surveys.
string
Phone number in E.164 format (e.g., +17132746524).

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

string
Unique identifier for the person.
object
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.
string
Person’s name.
string
Email address of the person.
string
required
Phone number in E.164 format (e.g., +17132746524). Must start with +, contain country code, and use only + and digits.

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: DELIGHTED_CREATE_PERSONCreate or update a person in Delighted, with custom properties and optional survey scheduling by email or SMS. A person can also be created or updated without scheduling a survey.

Input Parameters

string
Name of the person.
boolean
Whether to send the survey. Set to false to create/update person without scheduling survey delivery. Default is true.
integer
Number of seconds to wait before sending the survey. Default is 0 (send immediately).
string
Email address of the person. Required if phone_number is not provided.
string ("email" | "sms")
Communication channel for sending survey. Use ‘sms’ for SMS surveys or ‘email’ for email surveys (default).
object
Custom key-value pairs for segmentation and customization. Used for filtering and personalizing surveys.
string
New email address when updating an existing contact.
integer
Unix timestamp indicating when a survey was last sent to this person. Used to set previous survey send time.
string
Phone number in E.164 format (e.g., +17132746524). Required if channel is ‘sms’ or email is not provided.
string
New phone number in E.164 format when updating an existing 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: 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

string
required
The email address of the person whose pending survey requests should 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: 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

string
required
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

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

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

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: DELIGHTED_LIST_AUTOPILOT_SMS_MEMBERSHIPSList Autopilot SMS memberships, optionally filtering by person ID, email, or phone number. A response indicating that Autopilot is not configured is returned as an empty membership list.

Input Parameters

integer
Number of results per page. Default is 20, maximum is 100.
string
Filter results to a specific person by ID.
string
Filter results to a specific person by email address.
string
Filter results to a specific person by phone number in E.164 format (e.g., +17132746524).

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

integer
Page number to retrieve (default: 1).
integer
Unix timestamp filtering bounces on or after this date.
integer
Unix timestamp filtering bounces on or before this date.
integer
Number of results per page (default: 20, max: 100).

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

string
Filter results to a specific person by email address. Mutually exclusive with phone_number.
integer
Unix timestamp to filter people created on or after this time.
integer
Unix timestamp to filter people created on or before this time.
integer
Number of results per page. Default is 20, maximum is 100.
string
Cursor token for pagination. Use the next_page_info value from a previous response to retrieve the next page of results.
string
Filter results by phone number in E.164 format (e.g., ‘+17132746524’). Mutually exclusive with 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: 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

integer
Page number to retrieve (default: 1).
string
Sort order for responses based on creation or update time. Accepts ‘asc’ (default), ‘desc’, ‘asc:updated_at’, or ‘desc:updated_at’.
integer
Unix timestamp restricting responses to those created on or after this time.
string
ID of a trend to filter responses by that specific trend.
integer
Unix timestamp restricting responses to those created on or before this time.
array
Array specifying objects to expand. Supports ‘person’ and ‘notes’.
integer
Number of results per page (default: 20, max: 100).
string
ID restricting responses to a specific person.
string
Email address restricting responses to a specific person.
integer
Unix timestamp restricting responses to those updated on or after this time.
integer
Unix timestamp restricting responses to those updated on or before this time.

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

integer
Page number to retrieve (default: 1).
integer
Unix timestamp filtering unsubscribes on or after this date.
integer
Unix timestamp filtering unsubscribes on or before this date.
integer
Number of results per page (default: 20, max: 100).

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

string
required
The email address of the person to unsubscribe from surveys

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