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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnsubscribeEmailTopicResponse:
    email: Optional[str] = None
    configuration_set: Optional[str] = None
    topic: Optional[str] = None
    unsubscribed: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnsubscribeEmailTopic:
    # @ApiMember(Description="The email address to unsubscribe.", IsRequired=true)
    email: Optional[str] = None
    """
    The email address to unsubscribe.
    """


    # @ApiMember(Description="Configuration set identifier used when sending the email.", IsRequired=true)
    configuration_set: Optional[str] = None
    """
    Configuration set identifier used when sending the email.
    """


    # @ApiMember(Description="Topic identifier used when sending the email.", IsRequired=true)
    topic: Optional[str] = None
    """
    Topic identifier used when sending the email.
    """


    # @ApiMember(Description="Verification token from the unsubscribe link.", IsRequired=true)
    token: Optional[str] = None
    """
    Verification token from the unsubscribe link.
    """

Python 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>