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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

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 virtual string Email { get; set; }

        ///<summary>
        ///Configuration set identifier used when sending the email.
        ///</summary>
        [ApiMember(Description="Configuration set identifier used when sending the email.", IsRequired=true)]
        public virtual string ConfigurationSet { get; set; }

        ///<summary>
        ///Topic identifier used when sending the email.
        ///</summary>
        [ApiMember(Description="Topic identifier used when sending the email.", IsRequired=true)]
        public virtual string Topic { get; set; }

        ///<summary>
        ///Verification token from the unsubscribe link.
        ///</summary>
        [ApiMember(Description="Verification token from the unsubscribe link.", IsRequired=true)]
        public virtual string Token { get; set; }
    }

    public partial class UnsubscribeEmailTopicResponse
    {
        public virtual string Email { get; set; }
        public virtual string ConfigurationSet { get; set; }
        public virtual string Topic { get; set; }
        public virtual bool Unsubscribed { get; set; }
    }

}

C# 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>