Opt-outs
List opt-outs
Contacts that must not be written to on a channel. Newest first. source contact means they asked for it; organization means you set it.
Required scope: contacts:read.
query Parameters
limitcursorThe nextCursor of the previous page, with the same filters.
channelsourceHeaders
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
List opt-outs › Responses
objecthasMorenextCursorOpt a contact out
From now on nothing is sent to this contact on the channel: events, messages and campaigns skip them. Calling it again leaves the opt-out as it was.
Required scope: opt-outs:write.
path Parameters
contactId^ctc_[0-9A-Za-z]{22}… · requiredThe id of the contact (ctc_…).
channelThe channel to opt the contact out of.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Opt a contact out › Responses
objectcontactIdchannelsourcecontact: they asked for it. organization: you set it through the API.
createdAtClear an opt-out
Only clears opt-outs you set. One the contact asked for stays until they write again, and answers 409.
Required scope: opt-outs:write.
path Parameters
contactId^ctc_[0-9A-Za-z]{22}… · requiredThe id of the contact (ctc_…).
channelThe channel to clear the opt-out on.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.