BokaMera.API.Host

SyncCompanyCustomerMembers

The following routes are available for this service:
PUT	/mailchimp/member/company/customer/sync	sync mailchimp memebers


export class MemberTag
{
    public Id: number;
    public Name: string;
    public DateAdded?: string;
    public Status: string;

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

export class MemberResponse
{
    public EmailAddress: string;
    public FullName: string;
    public Tags: MemberTag[];

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

export class SyncMembersResponse
{
    public FailedSyncedMembers: MemberResponse[];
    public SuccessSyncedMembers: MemberResponse[];

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class SyncCompanyCustomerMembers implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Should we delete emails that do not exist in BokaMera. */
    // @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    public DeleteNonExisting: boolean;

    /** @description Should we target only subscribed to newsletter customers. */
    // @ApiMember(Description="Should we target only subscribed to newsletter customers.")
    public OnlySubscribed: boolean;

    /** @description Determines if it is a test user */
    // @ApiMember(Description="Determines if it is a test user")
    public Test: boolean;

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

TypeScript SyncCompanyCustomerMembers DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","DeleteNonExisting":false,"OnlySubscribed":false,"Test":false}

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}]}