BokaMera.API.Host

<back to all web services

CreateMailchimpProfile

Requires Authentication
The following routes are available for this service:
PUT/mailchimp/profilecreates mailchimp profile in bokamera
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MailchimpConfig() = 
        member val MailChimpApiKey:String = null with get,set
        member val MailChimpAudienceId:String = null with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<AllowNullLiteral>]
    type CreateMailchimpProfile() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", IsRequired=true)>]
        member val MailChimpApiKey:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="")>]
        member val MailChimpAudienceId:String = null with get,set

F# CreateMailchimpProfile 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/profile HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateMailchimpProfile 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>
  <MailChimpApiKey>String</MailChimpApiKey>
  <MailChimpAudienceId>String</MailChimpAudienceId>
</CreateMailchimpProfile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MailchimpConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MailChimpIntegration">
  <MailChimpApiKey>String</MailChimpApiKey>
  <MailChimpAudienceId>String</MailChimpAudienceId>
</MailchimpConfig>