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.
"use strict";
export class UnsubscribeEmailTopicResponse {
    /** @param {{Email?:string,ConfigurationSet?:string,Topic?:string,Unsubscribed?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Email;
    /** @type {string} */
    ConfigurationSet;
    /** @type {string} */
    Topic;
    /** @type {boolean} */
    Unsubscribed;
}
export class UnsubscribeEmailTopic {
    /** @param {{Email?:string,ConfigurationSet?:string,Topic?:string,Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The email address to unsubscribe. */
    Email;
    /**
     * @type {string}
     * @description Configuration set identifier used when sending the email. */
    ConfigurationSet;
    /**
     * @type {string}
     * @description Topic identifier used when sending the email. */
    Topic;
    /**
     * @type {string}
     * @description Verification token from the unsubscribe link. */
    Token;
}

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