BokaMera.API.Host

UnsubscribeEmailTopic

The following routes are available for this service:
POST	/unsubscribe	Unsubscribe an email from onboarding and similar campaign messages.	No authentication required.

namespace BokaMera.API.ServiceModel.Dtos

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

    [<AllowNullLiteral>]
    type UnsubscribeEmailTopicResponse() = 
        member val Email:String = null with get,set
        member val ConfigurationSet:String = null with get,set
        member val Topic:String = null with get,set
        member val Unsubscribed:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type UnsubscribeEmailTopic() = 
        ///<summary>
        ///The email address to unsubscribe.
        ///</summary>
        [<ApiMember(Description="The email address to unsubscribe.", IsRequired=true)>]
        member val Email:String = null with get,set

        ///<summary>
        ///Configuration set identifier used when sending the email.
        ///</summary>
        [<ApiMember(Description="Configuration set identifier used when sending the email.", IsRequired=true)>]
        member val ConfigurationSet:String = null with get,set

        ///<summary>
        ///Topic identifier used when sending the email.
        ///</summary>
        [<ApiMember(Description="Topic identifier used when sending the email.", IsRequired=true)>]
        member val Topic:String = null with get,set

        ///<summary>
        ///Verification token from the unsubscribe link.
        ///</summary>
        [<ApiMember(Description="Verification token from the unsubscribe link.", IsRequired=true)>]
        member val Token:String = null with get,set

F# UnsubscribeEmailTopic 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.

POST /unsubscribe HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UnsubscribeEmailTopic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ConfigurationSet>String</ConfigurationSet>
  <Email>String</Email>
  <Token>String</Token>
  <Topic>String</Topic>
</UnsubscribeEmailTopic>

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

<UnsubscribeEmailTopicResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ConfigurationSet>String</ConfigurationSet>
  <Email>String</Email>
  <Topic>String</Topic>
  <Unsubscribed>false</Unsubscribed>
</UnsubscribeEmailTopicResponse>