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

Unsubscribing people

Add a person to your unsubscribe list. The person will no longer receive any surveys via email. This is functionally equivalent to the person clicking “Unsubscribe” within a survey. It will not remove their previous survey responses.

Endpoint 

POST /v1/unsubscribes.json

Example request

Curl Ruby Node.js Python PHP 
curl https://api.delighted.com/v1/unsubscribes.json \
  -u YOUR_DELIGHTED_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{ "person_email": "jony@appleseed.com" }'
Delighted::Unsubscribe.create(person_email: 'jony@appleseed.com')
delighted.unsubscribe.create({ person_email: 'jony@appleseed.com' });
delighted.Unsubscribe.create(person_email='jony@appleseed.com')
\Delighted\Unsubscribe::create(array('person_email' => 'jony@appleseed.com'));

Example response 

{
  "ok": true
}

Parameters

Name Type Description
person_email String Email of the person. (required)