regis

<back to all web services

CMSummaryRequest

Requires Authentication
Required permission:CMPermission
The following routes are available for this service:
POST/CampaignMonitor/{email}/Summary
CMSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
emailpathstringNo
CMSummaryResponse Parameters:
NameParameterData TypeRequiredDescription
emailformstringNo
is_optinformboolNo
is_ebrformboolNo
is_express_consentformstringNo
is_suppressedformboolNo
last_consent_sourceformstringNo
last_consent_dateformDateTime?No
last_event_dateformDateTime?No
last_reframe_purchase_dateformDateTime?No
listsformList<CMListResponse>No
CMListResponse Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
nameformstringNo
statusformstringNo
segmentsformList<string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CampaignMonitor/{email}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	is_optin: False,
	is_ebr: False,
	is_express_consent: String,
	is_suppressed: False,
	last_consent_source: String,
	last_consent_date: 0001-01-01,
	last_event_date: 0001-01-01,
	last_reframe_purchase_date: 0001-01-01,
	lists: 
	[
		{
			id: String,
			name: String,
			status: String,
			segments: 
			[
				String
			]
		}
	]
}