BokaMera.API.Host

<back to all web services

UnsubscribeEmailTopic

The following routes are available for this service:
POST/unsubscribeUnsubscribe an email from onboarding and similar campaign messages.No authentication required.
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class UnsubscribeEmailTopic
            '''<Summary>
            '''The email address to unsubscribe.
            '''</Summary>
            <ApiMember(Description:="The email address to unsubscribe.", IsRequired:=true)>
            Public Overridable Property Email As String

            '''<Summary>
            '''Configuration set identifier used when sending the email.
            '''</Summary>
            <ApiMember(Description:="Configuration set identifier used when sending the email.", IsRequired:=true)>
            Public Overridable Property ConfigurationSet As String

            '''<Summary>
            '''Topic identifier used when sending the email.
            '''</Summary>
            <ApiMember(Description:="Topic identifier used when sending the email.", IsRequired:=true)>
            Public Overridable Property Topic As String

            '''<Summary>
            '''Verification token from the unsubscribe link.
            '''</Summary>
            <ApiMember(Description:="Verification token from the unsubscribe link.", IsRequired:=true)>
            Public Overridable Property Token As String
        End Class

        Public Partial Class UnsubscribeEmailTopicResponse
            Public Overridable Property Email As String
            Public Overridable Property ConfigurationSet As String
            Public Overridable Property Topic As String
            Public Overridable Property Unsubscribed As Boolean
        End Class
    End Namespace
End Namespace

VB.NET UnsubscribeEmailTopic DTOs

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

HTTP + JSON

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}