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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

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

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

    /**
    * Verification token from the unsubscribe link.
    */
    @ApiMember(Description="Verification token from the unsubscribe link.", IsRequired=true)
    open var Token:String? = null
}

open class UnsubscribeEmailTopicResponse
{
    open var Email:String? = null
    open var ConfigurationSet:String? = null
    open var Topic:String? = null
    open var Unsubscribed:Boolean? = null
}

Kotlin UnsubscribeEmailTopic DTOs

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

HTTP + CSV

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

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

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

{"Email":"String","ConfigurationSet":"String","Topic":"String","Unsubscribed":false}