latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Unsubscribe a member

Unsubscribe a member based on their key. The field isNewUnsubscription indicates whether the unsubscription was new or the member was already unsubscribed.

post/members/unsubscribed/{email}

Path parameters

keystring required

Can be either the member's email address or their numerical ID

Response

The unsubscribed member's details including whether this was a new unsubscription

firstnamestring

lastnamestring

companystring

emailstring email

genderstring

languagestring

joinedOnstring

updatedOnstring nullable

consentTypestring

postalCodestring

countrystring

notestring

birthdatestring nullable

unsubscribedOnstring

customFieldsobject

isNewUnsubscriptionboolean

Example response

{
  "firstname": "John",
  "lastname": "Doe",
  "company": "John Doe Company inc",
  "email": "john.doe@example.org",
  "gender": "m",
  "language": "en_ca",
  "joinedOn": "2015-10-05 11:09:04.710",
  "updatedOn": "2016-12-10 12:41:42.020",
  "consentType": "implied",
  "postalCode": "A0A 0A0",
  "country": "CA",
  "note": "He's awesome",
  "unsubscribedOn": "2015-10-05 11:09:04.710",
  "customFields": {
    "1": "this is a test !",
    "2": 6544,
    "3": 1.5,
    "4": "2000-01-01"
  },
  "isNewUnsubscription": true
}