DELETE/api/v1/projects/{project_id}/subscribers/{subscriber_id}

`erase_subscriber`

Erases a subscriber for good, on the person’s request to delete their data: its row (address, attributes, status) is deleted, and in its events and the address’s suppression events the address is replaced by an erased:<hash> marker, in the background; subscriber.erased records it. The address’s suppressions stay, so it gets no mail it opted out of if it is added again.

Call it: only when the data must go; to stop mail, unsubscribe instead.
Needs: an admin key with project_id, or a project key with scope write (its own project; the argument is ignored), the subscriber’s id, and confirm: true; without it the call changes nothing and tells what it would erase.
Returns: outcome (would_erase, erased), effect in words and the subscriber as get_subscriber returns it after the call (null once erased; a second call is not_found); the API’s DELETE /api/v1/projects/{project_id}/subscribers/{subscriber_id} answers 204.

Arguments

object
subscriber_idstring · uuidrequired

The subscriber’s id.
confirmboolean

true erases the subscriber. Without it the call only tells what would be erased and changes nothing.

default false
project_idstring · uuid | null

The subscriber’s project. An admin key must pass it; a project key’s own project is used and this is ignored.

No other arguments are accepted.

Result

The result comes back as structuredContent, with the same JSON as a text block.

object · all fields required
effectstring

What is or would be erased, in words, for the agent and its user.
outcomeErasureOutcomeOutput

What erase_subscriber did or, without confirm: true, would do.

would_erase A dry run: nothing changed; a call with confirm: true erases.

erased Erased now. An erased subscriber is gone: a second call is not_found.
subscriberSubscriber | null

The subscriber as it is now; null once erased.
12 fields
- Subscriber object · all fields required
- attributesmap of string → string | number | boolean
  
  The subscriber’s attributes: a map of string, number or boolean values.
- confirmed_atstring · date-time | null
  
  When the subscriber confirmed a double opt-in; null otherwise.
- created_atstring · date-time
- emailstring · email
- idstring · uuid
- list_idstring · uuid
  
  The list the subscriber is on.
- project_idstring · uuid
  
  The subscriber’s project.
- soft_bounce_streakinteger · uint32
  
  Soft bounces in a row; reset by a delivery (P4+).
  
  ≥ 0
- sourcestring
  
  How the subscriber was added: api, import or confirm.
- statusstring
  
  pending, active, unsubscribed, bounced or complained.
- unsubscribed_atstring · date-time | null
  
  When the subscriber unsubscribed; null otherwise.
- updated_atstring · date-time
  
  The latest change: creation, an attribute merge.

Definitions

ErasureOutcomeOutput

What erase_subscriber did or, without confirm: true, would do.

string · enum

would_erase A dry run: nothing changed; a call with confirm: true erases.

erased Erased now. An erased subscriber is gone: a second call is not_found.

Subscriber

A subscriber of a list (add_subscriber, find_subscriber, get_subscriber, update_subscriber_attributes).

object · all fields required
attributesmap of string → string | number | boolean

The subscriber’s attributes: a map of string, number or boolean values.
confirmed_atstring · date-time | null

When the subscriber confirmed a double opt-in; null otherwise.
created_atstring · date-time
emailstring · email
idstring · uuid
list_idstring · uuid

The list the subscriber is on.
project_idstring · uuid

The subscriber’s project.
soft_bounce_streakinteger · uint32

Soft bounces in a row; reset by a delivery (P4+).

≥ 0
sourcestring

How the subscriber was added: api, import or confirm.
statusstring

pending, active, unsubscribed, bounced or complained.
unsubscribed_atstring · date-time | null

When the subscriber unsubscribed; null otherwise.
updated_atstring · date-time

The latest change: creation, an attribute merge.

Errors

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors

HTTP API

The same operation over HTTP: DELETE /api/v1/projects/{project_id}/subscribers/{subscriber_id}