Customer Success

Delighted

Learn how to use Delighted with Composio

Overview

SLUG: DELIGHTED

Description

Delighted uses the Net Promoter System® to gather real feedback from your customers – in minutes, not weeks. No technical knowledge required.

Authentication Details

generic_api_key
stringRequired

Connecting to Delighted

Create an auth config

Use the dashboard to create an auth config for the Delighted toolkit. This allows you to connect multiple Delighted accounts to Composio for agents to use.

1

Select App

Navigate to Delighted.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Delighted Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4delighted_auth_config_id = "ac_YOUR_DELIGHTED_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Delighted for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, delighted_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Delighted toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add Person to Autopilot Email

Description

Tool to add a person to Autopilot or update their properties for email-based surveys. Use when you need to enroll a person in scheduled email surveys or update their custom properties.

Action Parameters

person_email
stringRequired
person_id
string
person_name
string
person_phone_number
string
properties
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Person to Autopilot SMS

Description

Tool 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.

Action Parameters

person_email
string
person_id
string
person_name
string
person_phone_number
stringRequired
properties
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create or Update Person

Description

Tool 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.

Action Parameters

channel
string
delay
integer
email
string
email_update
string
last_sent_at
integer
name
string
phone_number
string
phone_number_update
string
properties
object
send
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Pending Survey Requests

Description

Tool 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.

Action Parameters

person_email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Person

Description

Tool 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.

Action Parameters

person_identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Autopilot Email Configuration

Description

Tool to retrieve the current Autopilot configuration for email distribution. Returns configuration details including whether Autopilot is active, survey frequency, and timestamps.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Autopilot SMS Configuration

Description

Tool 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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Autopilot SMS Memberships

Description

Tool 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.

Action Parameters

per_page
integer
person_email
string
person_id
string
person_phone_number
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Bounced People

Description

Tool 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.

Action Parameters

page
integer
per_page
integer
since
integer
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List People

Description

Tool 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.

Action Parameters

email
string
per_page
integer
phone_number
string
since
integer
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Survey Responses

Description

Tool 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.

Action Parameters

expand
array
order
string
page
integer
per_page
integer
person_email
string
person_id
string
since
integer
trend
string
until
integer
updated_since
integer
updated_until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Unsubscribed People

Description

Tool 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.

Action Parameters

page
integer
per_page
integer
since
integer
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unsubscribe Person

Description

Tool 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.

Action Parameters

person_email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired