BokaMera.API.Host

<back to all web services

SyncCompanyMembers

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
PUT/mailchimp/member/company/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 SyncCompanyMembers
{
    /**
    * 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

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

    /**
    * The company id of member of which members you want to sync.
    */
    @ApiMember(Description="The company id of member of which members you want to sync.")
    var MemberCompanyId:UUID? = 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 SyncCompanyMembers DTOs

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

HTTP + CSV

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.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DeleteNonExisting":false,"Test":false,"MemberCompanyId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}]}