| PUT | /mailchimp/member/company/customer/sync | sync mailchimp memebers |
|---|
"use strict";
export class MemberTag {
/** @param {{Id?:number,Name?:string,DateAdded?:string,Status?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {?string} */
DateAdded;
/** @type {string} */
Status;
}
export class MemberResponse {
/** @param {{EmailAddress?:string,FullName?:string,Tags?:MemberTag[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
EmailAddress;
/** @type {string} */
FullName;
/** @type {MemberTag[]} */
Tags;
}
export class SyncMembersResponse {
/** @param {{FailedSyncedMembers?:MemberResponse[],SuccessSyncedMembers?:MemberResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {MemberResponse[]} */
FailedSyncedMembers;
/** @type {MemberResponse[]} */
SuccessSyncedMembers;
}
export class SyncCompanyCustomerMembers {
/** @param {{CompanyId?:string,DeleteNonExisting?:boolean,OnlySubscribed?:boolean,Test?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {boolean}
* @description Should we delete emails that do not exist in BokaMera. */
DeleteNonExisting;
/**
* @type {boolean}
* @description Should we target only subscribed to newsletter customers. */
OnlySubscribed;
/**
* @type {boolean}
* @description Determines if it is a test user */
Test;
}
JavaScript SyncCompanyCustomerMembers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /mailchimp/member/company/customer/sync HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","DeleteNonExisting":false,"OnlySubscribed":false,"Test":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"FailedSyncedMembers":[{"EmailAddress":"String","FullName":"String","Tags":[{"Id":0,"Name":"String","DateAdded":"0001-01-01T00:00:00","Status":"String"}]}],"SuccessSyncedMembers":[{"EmailAddress":"String","FullName":"String","Tags":[{"Id":0,"Name":"String","DateAdded":"0001-01-01T00:00:00","Status":"String"}]}]}