regis

<back to all web services

CMSummaryRequest

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

export class CMListResponse
{
    public id: string;
    public name: string;
    public status: string;
    public segments: string[];

    public constructor(init?: Partial<CMListResponse>) { (Object as any).assign(this, init); }
}

export class CMSummaryResponse
{
    public email: string;
    public is_optin: boolean;
    public is_ebr: boolean;
    public is_express_consent: string;
    public is_suppressed: boolean;
    public last_consent_source: string;
    public last_consent_date?: string;
    public last_event_date?: string;
    public last_reframe_purchase_date?: string;
    public lists: CMListResponse[];

    public constructor(init?: Partial<CMSummaryResponse>) { (Object as any).assign(this, init); }
}

export class CMSummaryRequest
{
    public email: string;

    public constructor(init?: Partial<CMSummaryRequest>) { (Object as any).assign(this, init); }
}

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