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.
UnsubscribeEmailTopic Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringYesThe email address to unsubscribe.
ConfigurationSetbodystringYesConfiguration set identifier used when sending the email.
TopicbodystringYesTopic identifier used when sending the email.
TokenbodystringYesVerification token from the unsubscribe link.
UnsubscribeEmailTopicResponse Parameters:
NameParameterData TypeRequiredDescription
EmailformstringYes
ConfigurationSetformstringYes
TopicformstringYes
UnsubscribedformboolNo

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.bookmore.com 
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
}