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.

import Foundation
import ServiceStack

public class UnsubscribeEmailTopic : Codable
{
    /**
    * The email address to unsubscribe.
    */
    // @ApiMember(Description="The email address to unsubscribe.", IsRequired=true)
    public var email:String

    /**
    * Configuration set identifier used when sending the email.
    */
    // @ApiMember(Description="Configuration set identifier used when sending the email.", IsRequired=true)
    public var configurationSet:String

    /**
    * Topic identifier used when sending the email.
    */
    // @ApiMember(Description="Topic identifier used when sending the email.", IsRequired=true)
    public var topic:String

    /**
    * Verification token from the unsubscribe link.
    */
    // @ApiMember(Description="Verification token from the unsubscribe link.", IsRequired=true)
    public var token:String

    required public init(){}
}

public class UnsubscribeEmailTopicResponse : Codable
{
    public var email:String
    public var configurationSet:String
    public var topic:String
    public var unsubscribed:Bool

    required public init(){}
}

Swift UnsubscribeEmailTopic DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	ConfigurationSet: String,
	Topic: String,
	Token: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	ConfigurationSet: String,
	Topic: String,
	Unsubscribed: False
}