Developer Documentation

This article provides details on the ‘Contact Opts out of Emails’ integration point.

JSON Message Structure

This is an example of the JSON message for this integration point. The data represents the opted-out contact.

{
  "eventType": "ContactOptedOut",
  "messageTime": "2018-03-01T15:09:20.950Z",
  "messageStub": "91e061d8-c97f-4a1e-ac14-8d276e6f7a53",
  "message": [
    {
      "contactStub": "E05C3E26-9F14-478D-A3E5-5ED1828A7520",
      "lastName": "Archer",
      "workStateCode": "",
      "contactSourceId": "",
      "gender": "Male",
      "prefix": "Mr.",
      "customFields": [
        {
          "id": "12347D26-3FBD-4ACF-BBC3-BC2ABD0608D7",
          "name": "Years of experience",
          "value": "11-15"
        },
        {
          "id": "84C1DBCA-4586-4E59-A4EA-B77F7E1FF941",
          "name": "T-shirt size",
          "value": "M"
        }
      ],
      "workZipcode": "",
      "contactType": "",
      "workCountry": "",
      "updatedDate": "2018-03-26",
      "title": "Student",
      "homeStateCode": "",
      "optedOut": "no",
      "workState": "ARIZONA",
      "workCity": "Saint York",
      "homeCity": "York York",
      "company": "East Talent",
      "accountStub": "7F4E8204-028E-450A-94E3-BE870D7D05A5",
      "email": "test@example.com",
      "homeZipcode": "73456",
      "homeFax": "565-851-9873",
      "ccEmail": "test+cc@example.com",
      "nickName": "Vader",
      "homePhone": "853-123-9876",
      "fullName": "James Jones",
      "dateOfBirth": "04-May-2024",
      "homeState": "CALIFORNIA",
      "workFax": "874-898-5678",
      "workAddress1": "654 West Street",
      "workAddress2": "Suite 345",
      "firstName": "James",
      "homeAddress3": "Apt 1",
      "workAddress3": "Apt 321",
      "homeAddress2": "West Side",
      "workCountryCode": "US",
      "homeAddress1": "598 East Street",
      "mobilePhone": "765-234-6775",
      "middleName": "E",
      "workPhone": "653-436-2365",
      "designation": "CPA",
      "homeCountry": "USA"
    }
  ]
}

Understanding the JSON Message

Arrays: The customFields array is dynamic and changes over time as planners add or remove custom fields.
Empty Fields: Fields appearing as empty ("") indicate no data is available for that field.

Last updated on January 8, 2025

Contact Opts Back in to Emails Session Created