OptInOverviewDTO

JSON representation of a summary of an Opt-In operation.

Fields

Type
Name
Description
Optional
Default Value
Map
Object
Object
properties
A map containing arbitrary information of the contact.
false
 
List
OptInInfoDTO
optIns
A list of Opt-In records for the given contact id.
false
 

Example

{
	"properties" : {
		"contactId" : "example@example.org",
		"pk" : "pk123",
		"adBlocked" : false
	},
	"optIns" : [
		{
			"pk" : "opt123",
			"type" : "C0INFOTYPE_NEWSLETTER",
			"status" : "C0OPTINSTATUS_CURRENT",
			"approval" : "Zus_C0Approval",
			"extRefNo" : "aabbccdd-1234-1234-1234-aabbccddeeff"
		},
		{
			"pk" : "opt456",
			"type" : "C0INFOTYPE_PRODUCTINFO",
			"status" : "C0OPTINSTATUS_CURRENT",
			"approval" : "Zus_C0Approval",
			"extRefNo" : "aabbccdd-1234-1234-1234-aabbccddeeff"
		},
		{
			"pk" : "opt456",
			"type" : "C0INFOTYPE_SURVEYS",
			"status" : "C0OPTINSTATUS_CURRENT",
			"approval" : "Abl_C0Approval",
			"extRefNo" : "aabbccdd-1234-1234-1234-aabbccddeeff"
		}
	]
}