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 members
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class SyncCompanyCustomerMembers
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''Should we delete emails that do not exist in BokaMera.
            '''</Summary>
            <ApiMember(Description:="Should we delete emails that do not exist in BokaMera.")>
            Public Overridable Property DeleteNonExisting As Boolean

            '''<Summary>
            '''Should we target only subscribed to newsletter customers.
            '''</Summary>
            <ApiMember(Description:="Should we target only subscribed to newsletter customers.")>
            Public Overridable Property OnlySubscribed As Boolean

            '''<Summary>
            '''Determines if it is a test user
            '''</Summary>
            <ApiMember(Description:="Determines if it is a test user")>
            Public Overridable Property Test As Boolean
        End Class
    End Namespace
End Namespace

VB.NET SyncCompanyCustomerMembers DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SyncCompanyCustomerMembers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DeleteNonExisting>false</DeleteNonExisting>
  <OnlySubscribed>false</OnlySubscribed>
  <Test>false</Test>
</SyncCompanyCustomerMembers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />