Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

Subscribers

Subscribers of a project’s lists

The same group in the HTTP API

ToolConfirmProjectWhat it does
list_subscribersoptionalLists a list’s subscribers, ordered by id, at most 100 per call, with an optional status filter.
add_subscriberoptionalAdds a subscriber to a list, or merges attributes into one already on it.
find_subscriberoptionalFinds a subscriber by its email on a list.
import_subscribersoptionalAdds a batch of up to 1 000 subscribers to a list in one call and reports record by record.
get_subscriberoptionalReads one subscriber by its id, whatever list it is on: its email, attributes and status.
update_subscriber_attributesoptionalChanges a subscriber’s attributes, merging the ones you give into the ones it has (new values win, null removes a key); the status is never changed.
erase_subscriberconfirmoptionalErases a subscriber for good, on the person’s request to delete their data: its row (address, attributes, status) is deleted, and in its events and the…
get_subscriber_eventsoptionalLists a subscriber’s history: the events about it (subscriber.created, subscriber.unsubscribed, subscriber.resubscribed, …) since it was added, oldest…
reactivate_subscriberoptionalTakes a bounced or complained subscriber back to active.
resubscribe_subscriberoptionalSubscribes an unsubscribed subscriber again, with fresh consent: active, or pending on a list with double opt-in; the suppression its unsubscribe left is…
unsubscribe_subscriberoptionalUnsubscribes a subscriber: from its list, or (scope: "project") the address from every list of the project.