| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Email":"String","ConfigurationSet":"String","Topic":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Email":"String","ConfigurationSet":"String","Topic":"String","Unsubscribed":false}