Simulations

Sandbox: return a check to sender

Changed on

Drive a sandbox check mail delivery to returned-to-sender, firing the returned-to-sender webhook

post/simulations/check/{checkId}/return-to-sender

Request

  • Base URL
    https://api.sandbox.natural.com
  • URL
    https://api.sandbox.natural.com/simulations/check/{checkId}/return-to-sender
  • Auth
    HTTP bearer

Path parameters

checkIdstring required

Check ID (chk_*).

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes