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
SyncCompanyMembers Parameters:
NameParameterData TypeRequiredDescription
DeleteNonExistingbodyboolNoShould we delete emails that do not exist in BokaMera.
TestbodyboolNoDetermines if it is a test user
MemberCompanyIdbodyGuid?NoThe company id of member of which members you want to sync.
SyncMembersResponse Parameters:
NameParameterData TypeRequiredDescription
FailedSyncedMembersformList<MemberResponse>No
SuccessSyncedMembersformList<MemberResponse>No
MemberResponse Parameters:
NameParameterData TypeRequiredDescription
EmailAddressformstringNo
FullNameformstringNo
TagsformList<MemberTag>No
MemberTag Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DateAddedformDateTime?No
StatusformstringNo

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: testapi.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"}]}]}