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
SyncCompanyCustomerMembers Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
DeleteNonExistingbodyboolNoShould we delete emails that do not exist in BokaMera.
OnlySubscribedbodyboolNoShould we target only subscribed to newsletter customers.
TestbodyboolNoDetermines if it is a test user
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	DeleteNonExisting: False,
	OnlySubscribed: False,
	Test: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
				}
			]
		}
	]
}