Marketing (experimental)

Unsubscribe a contact from a list

EXPERIMENTAL — enabled account by account; without it every call answers 403 module_disabled. Scopes read:contacts / write:contacts. Reason api: the API can subscribe again someone the API removed. This never suppresses the address — transactional email keeps flowing.

post/lists/{id}/unsubscribe

Request

  • Base URL: https://api.oveyon.com/v1
  • URL: https://api.oveyon.com/v1/lists/{id}/unsubscribe
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

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

Status on this list now

contactIdinteger required
listIdinteger required
status'unsubscribed' | 'null' nullable required

null when the contact was never on this list.

changedboolean required

Changes

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