HomeTutorialsAPI ReferenceStatus
API Reference

Unsubscribe - Public

post
https://{APP_DOMAIN}/api/3.2/o/unsubscribe

Unsubscribes a visitor using the signed hash embedded in outgoing emails. Passing segment_ids only removes the visitor from those segments. Passing tag_ids only detaches those tags. With neither, the full subscription is unsubscribed. Arbitrary additional fields are saved as subscriber variables.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body Params

string
required

The signed subscriber hash from the email.

segment_ids
array of integers

Optional segment IDs to unsubscribe from (partial opt-out).

segment_ids
tag_ids
array of integers

Optional tag IDs to detach from the subscription (partial opt-out).

tag_ids
string

Optional reason text.

string

Optional free-form comment.

Response
200

The cancelled subscription, or segment/tag opt-out confirmation.

Updated about 3 hours ago

Language
URL
LoadingLoading…

Updated about 3 hours ago