Guide
How to Prepare API JSON for a Support Ticket
Format, reduce, and redact JSON payloads so a support team can reproduce a problem without receiving unnecessary private data.
Last updated: 2026-07-23
Format first
Compact JSON is hard to review. Format the payload before changing it so nested objects, arrays, and repeated structures become visible. Once the shape is readable, it is easier to find the field that matters to the bug or support question.
Reduce the payload
A complete production response can be thousands of lines long. Keep only the fields needed to reproduce the issue, such as status, relevant IDs, timestamps, error messages, and one representative nested record. Smaller examples are easier for support teams to test and less likely to expose private information.
Redact secrets and identifiers
Remove access tokens, API keys, session IDs, customer emails, phone numbers, internal URLs, and exact account identifiers unless the support team explicitly requires them through a secure channel. Replace them with stable placeholders so the structure remains understandable.
Keep data types intact
When replacing values, preserve whether a field is a string, number, boolean, null, object, or array. Changing an ID from a number to a quoted string can hide the original bug or create a new one.
Validate after every edit
Redaction can easily break JSON by removing a quote or comma. Validate the final example after edits, then copy that version into the support ticket.
Document related timestamps
If the issue depends on event order, convert Unix timestamps or ISO dates into UTC notes. Keep the original timestamp fields in the JSON so engineers can reproduce the exact request.