Skip to main content

Dry-Run Mode

Append ?dry_run=true only to a supported operation. Authentication, authorization, and applicable request validation still run. A successful dry run does not reserve resources or guarantee that a later real write succeeds.

Supported endpointsDirect link to Supported endpoints

Paths below start with /v1/partnership/accounts/{account_id} unless shown in full.

PathMethodDry-run behavior
/marketplacecontrolslistsPUTExisting validation without saving.
/statusPUTExisting status validation without saving.
/data-deletion-requestsPOSTValidates without submitting account-deletion work.
/layouts/{layout_id}PATCH400 DryRunNotSupported, before work.
/pagesPOST400 DryRunNotSupported, before work.
/pages/{page_id}PUT400 DryRunNotSupported, before work.
/payout-setupPOST400 DryRunNotSupported, before work.
/v1/accounts/register/partnershipPOSTUnsupported; the flag does not suppress registration.
/v1/partnership/network-privacy-requestsPOSTUnsupported; the request is submitted normally.

Do not use the flag as a safety mechanism on any other endpoint. Test layout rendering with real updates on a stage merchant until these previews are available. A dry run is request validation, not browser rendering or a complete end-to-end test.

Supported dry runs bypass the operation cache and do not consume an idempotency key or create a pollable operation. Use an Idempotency-Key for the subsequent real operation.

Was this article helpful?
Last updated Oct 13, 2026