Cancel Run by ID

delete

https://broker-api.sandbox.alpaca.markets/v1/rebalancing/runs/{run_id}

Cancels a run so it does not start, or is not retried. Only a run in QUEUED or IN_PROGRESS can be canceled. A run in any other status is rejected. Canceling does not stop a run that is already placing orders: those orders are not canceled, and the run's final status can replace CANCELED.

Responses

204

No Content

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401The request is not authenticated. Send a valid API key ID and secret, or a Broker Dashboard session, and try again.

403These credentials are not allowed to call this endpoint, or rebalancing is not enabled for the correspondent. Use credentials with the required permission and try again.

404No rebalance run with this ID exists for your correspondent. Check the run ID and try again.

422The request failed validation or cannot be completed in its current state. The message describes the reason.

500Something went wrong on our side while handling the request. Retry with backoff. If it keeps happening, contact support.