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.


export class UnsubscribeEmailTopicResponse
{
    public Email: string;
    public ConfigurationSet: string;
    public Topic: string;
    public Unsubscribed: boolean;

    public constructor(init?: Partial<UnsubscribeEmailTopicResponse>) { (Object as any).assign(this, init); }
}

export class UnsubscribeEmailTopic
{
    /** @description The email address to unsubscribe. */
    // @ApiMember(Description="The email address to unsubscribe.", IsRequired=true)
    public Email: string;

    /** @description Configuration set identifier used when sending the email. */
    // @ApiMember(Description="Configuration set identifier used when sending the email.", IsRequired=true)
    public ConfigurationSet: string;

    /** @description Topic identifier used when sending the email. */
    // @ApiMember(Description="Topic identifier used when sending the email.", IsRequired=true)
    public Topic: string;

    /** @description Verification token from the unsubscribe link. */
    // @ApiMember(Description="Verification token from the unsubscribe link.", IsRequired=true)
    public Token: string;

    public constructor(init?: Partial<UnsubscribeEmailTopic>) { (Object as any).assign(this, init); }
}

TypeScript UnsubscribeEmailTopic DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	ConfigurationSet: String,
	Topic: String,
	Token: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	ConfigurationSet: String,
	Topic: String,
	Unsubscribed: False
}