PUT | /mailchimp/member/company/customer/sync | sync mailchimp memebers |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
DeleteNonExisting | body | bool | No | Should we delete emails that do not exist in BokaMera. |
OnlySubscribed | body | bool | No | Should we target only subscribed to newsletter customers. |
Test | body | bool | No | Determines if it is a test user |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FailedSyncedMembers | form | List<MemberResponse> | No | |
SuccessSyncedMembers | form | List<MemberResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EmailAddress | form | string | No | |
FullName | form | string | No | |
Tags | form | List<MemberTag> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
DateAdded | form | DateTime? | No | |
Status | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } ] } ] }