Dry Run Mode

Supported mutation endpoints can be executed in dry run mode by adding the dryRun=true query parameter.

curl 'https://api.vrplatform.app/transactions?dryRun=true' \
  -X POST \
  -H 'content-type: application/json' \
  -H 'x-api-key: your-api-key' \
  -H 'x-team-id: your-team-id' \
  --data '{ ... }'

Behavior

Dry run mode:

• Runs the normal business validation.
• Runs the normal locking checks.
• Returns the normal response payload for the endpoint.
• Does not persist database changes.
• Does not create an audit action for the request.

Response Headers

For supported dry run requests, the response headers differ from a normal mutation request:

• X-VRPlatform-Audit-Should-Poll: false
• X-VRPlatform-Audit-Action-Id is omitted

Supported Endpoints

Current dry run support is available for create, update, and delete endpoints under:

• transactions
• contacts
• reservations
• listings
• bank-records (POST /bank-records/batch, PUT /bank-records/{id})

Related

• Authentication
• API Specification