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
import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class SyncCompanyCustomerMembers implements ICompany, IConvertible
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

    /**
    * Should we delete emails that do not exist in BokaMera.
    */
    // @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    bool? DeleteNonExisting;

    /**
    * Should we target only subscribed to newsletter customers.
    */
    // @ApiMember(Description="Should we target only subscribed to newsletter customers.")
    bool? OnlySubscribed;

    /**
    * Determines if it is a test user
    */
    // @ApiMember(Description="Determines if it is a test user")
    bool? Test;

    SyncCompanyCustomerMembers({this.CompanyId,this.DeleteNonExisting,this.OnlySubscribed,this.Test});
    SyncCompanyCustomerMembers.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        DeleteNonExisting = json['DeleteNonExisting'];
        OnlySubscribed = json['OnlySubscribed'];
        Test = json['Test'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'DeleteNonExisting': DeleteNonExisting,
        'OnlySubscribed': OnlySubscribed,
        'Test': Test
    };

    getTypeName() => "SyncCompanyCustomerMembers";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'SyncCompanyCustomerMembers': TypeInfo(TypeOf.Class, create:() => SyncCompanyCustomerMembers()),
});

Dart SyncCompanyCustomerMembers DTOs

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

HTTP + OTHER

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: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","DeleteNonExisting":false,"OnlySubscribed":false,"Test":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}