regis

<back to all web services

CMSummaryRequest

Requires Authentication
Required permission:CMPermission
The following routes are available for this service:
POST/CampaignMonitor/{email}/Summary
import Foundation
import ServiceStack

public class CMSummaryRequest : Codable
{
    public var email:String

    required public init(){}
}

public class CMSummaryResponse : Codable
{
    public var email:String
    public var is_optin:Bool
    public var is_ebr:Bool
    public var is_express_consent:String
    public var is_suppressed:Bool
    public var last_consent_source:String
    public var last_consent_date:Date?
    public var last_event_date:Date?
    public var last_reframe_purchase_date:Date?
    public var lists:[CMListResponse] = []

    required public init(){}
}

public class CMListResponse : Codable
{
    public var id:String
    public var name:String
    public var status:String
    public var segments:[String] = []

    required public init(){}
}


Swift CMSummaryRequest DTOs

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
			]
		}
	]
}