HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

UnsubscribeWebservice

With this web service you can query, update or delete unsubscribes in Optimizely Campaign.

MethodDescription
addAdds a recipient to a unsubscribe list.
addAllAdds multiple recipients to a unsubscribe list.
addByMailIdUnsubscribes a recipient that belongs to a specific mail ID.
containsQueries the unsubscribe status of a recipient.
containsAllQueries the unsubscribe status of multiple recipients.
containsAllByRecipientListQueries whether multiple recipients are contained in a recipient list-based unsubscribe list.
containsByRecipientListQueries whether a recipient is contained in a recipient list-based unsubscribe list.
getCountCount the recipients that are currently unsubscribed.
removeRemoves a recipient from the internal unsubscribe list.
removeAllRemoves multiple recipients from the internal unsubscribe list.
removeAllByRecipientListRemoves multiple recipients from a recipient list-based unsubscribe list.
removeByRecipientListRemoves a recipient from a recipient list-based unsubscribe list.

Unsubscribe list

Each client uses one unsubscribe list. If there is an unsubscribe for any recipient list the recipient is added to this list and will not receive any further mailings send by this client.

Internal processing of unsubscribes

Internally, an unsubscribe event does not simply remove a recipient from the corresponding recipient list. Each unsubscribe is stored internally and must be removed explicitly. This is done if the recipient re-subscribes via a web form or by invoking the remove method.


What’s Next
Did this page help you?