Sign in
Subscriptions

UnsubscribeSubscription

Unsubscribe a subscription

post/subscription/unsubscribe

Request body

subscriptionIdstring required
<p>The subscription ID.</p>
channelIdstring required
<p>The channel ID.</p>
optOutSourcestring required
<p>The opt-out source.</p>
markAsUnsubscribedboolean
<p>Set to true to specifically handle email unsubscription (will mark email as blocked instead of removing the subscription).</p>
topicsstring[]
<p>Array of topic IDs to unsubscribe from. And it will be used only if <code>markAsUnsubscribed</code> is true.</p>

Response

Success-Response:

successboolean
idstring required
<p>The Subscription ID</p>

Changes

No recorded changes to this endpoint across all 2 revisions of this API.