Marketing (experimental)

Delete a contact

EXPERIMENTAL — enabled account by account; without it every call answers 403 module_disabled. Scopes read:contacts / write:contacts. By email OR id (exactly one). The contact leaves every list at once; 30 days later its data is erased (see purgeAfter). A hash of the address is kept so a re-import does not subscribe again someone who unsubscribed through the link or complained.

delete/contacts

Request

  • Base URL: https://api.oveyon.com/v1
  • URL: https://api.oveyon.com/v1/contacts
  • Auth: HTTP bearer

Query parameters

emailstring

The contact’s email, normalized as on POST /v1/contacts: only ASCII whitespace (space, TAB, LF, VT, FF, CR) is trimmed from the ends; a Unicode space at either end (NBSP, U+3000…) is 400 invalid_email. ASCII only: the Unicode spelling of a domain is 400 invalid_email with reason: address_not_ascii — the contact exists only in its xn-- form.

idinteger

Response

Deleted

idinteger required
deletedtrue required
listsinteger[] required

The lists the contact was unsubscribed from (reason operator).

purgeAfterstring date-time required

From then on (30 days) the contact, its tags, its timeline and its subscriptions are erased. A hash of the address stays, so a re-import does not bring back someone who unsubscribed.

Changes

No recorded changes to this operation across all 1 revision of this API.