BokaMera.API.Host

<back to all web services

SyncCompanyCustomerMembers

Requires Authentication
The following routes are available for this service:
PUT/mailchimp/member/company/customer/syncSync mailchimp members
"use strict";
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 .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.

PUT /mailchimp/member/company/customer/sync HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	DeleteNonExisting: False,
	OnlySubscribed: False,
	Test: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}