API documentation

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 https://api.delighted.com/v1/unsubscribes.json \
  -u YOUR_DELIGHTED_API_KEY: \
  -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)