HomeTutorialsAPI ReferenceStatus
API Reference

Record Opt-Out - Public

post
https://{APP_DOMAIN}/api/3.2/o/messages/opt-outs

Records an opt-out using a signed submailing_hash from an outgoing email. With segment_ids only, removes the subscriber from those segments. With tag_ids only, detaches those tags. With neither, records a full unsubscribe and triggers reporting integrations (e.g. Infusionsoft OptOut).

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

Body Params

string
required

Signed hash uniquely identifying the subscriber/mailing (from the email).

segment_ids
array of integers

Optional segment IDs to opt out of (partial opt-out).

segment_ids
tag_ids
array of integers

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

tag_ids
tags
array of strings

Optional tag names to pass to Infusionsoft integrations.

tags
string
enum

Optional reason code.

Allowed:
string

Optional free-form comments.

Response
201

The opt-out was recorded.

Updated about 3 hours ago

Language
URL
LoadingLoading…

Updated about 3 hours ago