block_subscriber()

Add a subscriber to the blocklist, effectively unsubscribing them so they will not receive any mail.

Usage

Source

block_subscriber(
    subscriber,
    timeout_config=None,
)

This is a convenience wrapper around update_subscriber that sets the status to SubscriberStatuses.blocklisted. Use delete_subscriber instead if you want to remove the subscriber record entirely.

Parameters

subscriber: models.Subscriber

The subscriber to block/unsubscribe. Must have a valid id.

timeout_config: Optional[httpx.Timeout] = None

Optional per-request timeout; defaults to 10 seconds.

Returns

Optional[models.Subscriber]

The refreshed subscriber object from the server, or None if the subscriber can no longer be found.

Raises

ValueError

If subscriber is None or has no id.

OperationNotAllowedError

If the base URL is not set or you are not logged in.

httpx.HTTPStatusError

If the server responds with a 4xx or 5xx status.

ValidationError

If the follow-up fetch returns an empty or invalid JSON response.