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


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class SyncCompanyCustomerMembers : 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.")
    var CompanyId:UUID? = null

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

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

    /**
    * Determines if it is a test user
    */
    @ApiMember(Description="Determines if it is a test user")
    var Test:Boolean? = null
}

open class SyncMembersResponse
{
    var FailedSyncedMembers:ArrayList<MemberResponse> = ArrayList<MemberResponse>()
    var SuccessSyncedMembers:ArrayList<MemberResponse> = ArrayList<MemberResponse>()
}

open class MemberResponse
{
    var EmailAddress:String? = null
    var FullName:String? = null
    var Tags:ArrayList<MemberTag> = ArrayList<MemberTag>()
}

open class MemberTag
{
    var Id:Int? = null
    var Name:String? = null
    var DateAdded:Date? = null
    var Status:String? = null
}

Kotlin 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: api.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

{"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"}]}]}