1. Sign in

API documentation

Table of contents

  1. Introduction
  2. Libraries
  3. Sending to people
  4. Listing survey responses
  5. Getting metrics
  6. Adding survey responses
  7. Deleting pending survey requests
  8. Unsubscribing people
  9. Listing people
  10. Listing unsubscribed people
  11. Listing bounced people
  12. Deleting people
  13. Getting Autopilot configuration
  14. Listing people in Autopilot
  15. Adding people to Autopilot
  16. Removing people from Autopilot
  17. Webhooks
  18. Web snippet

Getting Autopilot configuration

Retrieve the current Autopilot configuration for for the designated distribution platform.

Endpoint

For email:
GET /v1/autopilot/email.json
For SMS:
GET /v1/autopilot/sms.json

Example request

Curl Ruby Node.js Python PHP 
curl https://api.delighted.com/v1/autopilot/email.json \
  -u YOUR_DELIGHTED_API_KEY: \
  -H "Content-Type: application/json"
config = Delighted::AutopilotConfiguration.retrieve("email")
config = delighted.autopilotConfiguration.retrieve('email');
$config = \Delighted\AutopilotConfiguration::retrieve('email');
config = delighted.AutopilotConfiguration.retrieve('email')

Example response 

{
  "platform_id": "email",
  "active": true,
  "frequency": 7776000,
  "created_at": 1726980419,
  "updated_at": 1734241619
}

Response

Name Type Description
platform_id String The name of the distribution platform this Autopilot configuration is set for.
active Boolean Whether Autopilot is active for this distribution platform or not.
frequency Integer Number of seconds between recurring surveys for people in Autopilot for this distribution platform
created_at Timestamp A Unix timestamp describing when the Autopilot configuration for this distribution platform was first set up.
updated_at Timestamp A Unix timestamp describing when the Autopilot configuration for this distribution platform was last changed.