API documentation

Deleting people

Delete a person and all information related to them, including:

  • Surveys (including any scheduled or pending surveys)
  • Responses (scores, comments, notes, and tags)
  • Properties
  • Autopilot membership
  • Survey history
  • Links to integrations (such as Segment or Intercom)
  • Unsubscribe/bounce status

Endpoint

DELETE /v1/people/{PERSON_IDENTIFIER}

Example request

curl https://api.delighted.com/v1/people/email:jony@appleseed.com \
  -u YOUR_DELIGHTED_API_KEY: \
  -X DELETE
Delighted::Person.delete(email: "jony@appleseed.com")
delighted.person.delete({ email: "jony@appleseed.com" });
delighted.Person.delete(email="jony@appleseed.com")
\Delighted\Person::delete(array("email" => "jony@appleseed.com"));

Example response

{
  "ok": true
}

HTTP status code

Upon successfully requesting the deletion of the specified person, this endpoint will return an HTTP response code of 202.

Parameters

Name Type Description
id String You can specify the person to delete by ID, email, or phone number (in E.164 format):
  • ID: /v1/people/24248363
  • Email: /v1/people/email:jony@appleseed.com
  • Phone number: /v1/people/phone_number:+17132746524