docs: document open_tracking suppression type - #591
Open
rafaelmatsumotomb wants to merge 1 commit into
Open
Conversation
…ion type Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
open_trackingsuppression type in the Suppression List API docs (tracking-consent revocation — knowledge-base #43, live in production).Covered:
open_trackingadded to everytype/typesenum (suppression object, bulk PUT, single PUT, retrieve, delete, search)Tracking Consent Revokedlist_idnot supported for the type (with the 400 example), and the updated "Type must be one of" error texttransactional/non_transactional—open_trackingentries must be requested explicitly🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes to the API blueprint with no runtime or security impact.
Overview
Documents the
open_trackingsuppression type in the Suppression List API reference, for recipients who revoke open-tracking consent.The intro clarifies that
open_trackingdoes not block delivery—mail sends as usual, but no open events are recorded (the pixel is still served).open_trackingis added to all relevanttype/typesenums (object, bulk/single PUT, retrieve, delete, search), along with sourceTracking Consent Revoked.list_idis documented as unsupported for this type (always account-wide), including a new 400 example and updated allowed-type error text.Read and delete defaults are spelled out: without
types/type, onlytransactionalandnon_transactionalentries are returned or removed;open_trackingmust be requested explicitly.Reviewed by Cursor Bugbot for commit 6936192. Bugbot is set up for automated code reviews on this repo. Configure here.