| PUT | /mailchimp/member/company/customer/sync | sync mailchimp memebers |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberTag:
id: int = 0
name: Optional[str] = None
date_added: Optional[datetime.datetime] = None
status: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberResponse:
email_address: Optional[str] = None
full_name: Optional[str] = None
tags: Optional[List[MemberTag]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SyncMembersResponse:
failed_synced_members: Optional[List[MemberResponse]] = None
success_synced_members: Optional[List[MemberResponse]] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SyncCompanyCustomerMembers(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
delete_non_existing: bool = False
"""
Should we delete emails that do not exist in BokaMera.
"""
# @ApiMember(Description="Should we target only subscribed to newsletter customers.")
only_subscribed: bool = False
"""
Should we target only subscribed to newsletter customers.
"""
# @ApiMember(Description="Determines if it is a test user")
test: bool = False
"""
Determines if it is a test user
"""
Python SyncCompanyCustomerMembers DTOs
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
}
]
}
]
}