regis

CMSummaryRequest

**Requires Authentication**
Required permission:	CMPermission

The following routes are available for this service:
POST	/CampaignMonitor/{email}/Summary

"use strict";
export class CMListResponse {
    /** @param {{id?:string,name?:string,status?:string,segments?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    status;
    /** @type {string[]} */
    segments;
}
export class CMSummaryResponse {
    /** @param {{email?:string,is_optin?:boolean,is_ebr?:boolean,is_express_consent?:string,is_suppressed?:boolean,last_consent_source?:string,last_consent_date?:string,last_event_date?:string,last_reframe_purchase_date?:string,lists?:CMListResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
    /** @type {boolean} */
    is_optin;
    /** @type {boolean} */
    is_ebr;
    /** @type {string} */
    is_express_consent;
    /** @type {boolean} */
    is_suppressed;
    /** @type {string} */
    last_consent_source;
    /** @type {?string} */
    last_consent_date;
    /** @type {?string} */
    last_event_date;
    /** @type {?string} */
    last_reframe_purchase_date;
    /** @type {CMListResponse[]} */
    lists;
}
export class CMSummaryRequest {
    /** @param {{email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
}

JavaScript CMSummaryRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"email":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","last_event_date":"0001-01-01T00:00:00.0000000","last_reframe_purchase_date":"0001-01-01T00:00:00.0000000","lists":[{"id":"String","name":"String","status":"String","segments":["String"]}]}