BokaMera.API.Host

<back to all web services

SyncCompanyMembers

The following routes are available for this service:
PUT/mailchimp/member/company/syncSync Mailchimp members
"use strict";
export class SyncCompanyMembers {
    /** @param {{DeleteNonExisting?:boolean,Test?:boolean,Manual?:boolean,MemberCompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description Should we delete emails that do not exist in BokaMera. */
    DeleteNonExisting;
    /**
     * @type {boolean}
     * @description Determines if it is a test user */
    Test;
    /**
     * @type {boolean}
     * @description Determines if it sync was executed manually by click in superAdmin */
    Manual;
    /**
     * @type {?string}
     * @description The company id of member of which members you want to sync. */
    MemberCompanyId;
}

JavaScript SyncCompanyMembers 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/sync HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DeleteNonExisting: False,
	Test: False,
	Manual: False,
	MemberCompanyId: 00000000-0000-0000-0000-000000000000
}