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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class SyncCompanyCustomerMembers implements ICompany
    {
        /**
        * 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 UUID CompanyId = null;

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

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

        /**
        * Determines if it is a test user
        */
        @ApiMember(Description="Determines if it is a test user")
        public Boolean Test = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public SyncCompanyCustomerMembers setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Boolean isDeleteNonExisting() { return DeleteNonExisting; }
        public SyncCompanyCustomerMembers setDeleteNonExisting(Boolean value) { this.DeleteNonExisting = value; return this; }
        public Boolean isOnlySubscribed() { return OnlySubscribed; }
        public SyncCompanyCustomerMembers setOnlySubscribed(Boolean value) { this.OnlySubscribed = value; return this; }
        public Boolean isTest() { return Test; }
        public SyncCompanyCustomerMembers setTest(Boolean value) { this.Test = value; return this; }
    }

}

Java SyncCompanyCustomerMembers DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{}