| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"Email":"String","ConfigurationSet":"String","Topic":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Email":"String","ConfigurationSet":"String","Topic":"String","Unsubscribed":false}