Skip to main content
POST
Cancel orders by user reference
Cancel every open order in the given game whose userReference matches one of the supplied references. Useful when you’ve tagged orders with your own ids and want to cancel by those instead of tracking 4casters order ids.

Request

POST /session/cancelByReference
string
required
Scope the search to a single game.
array
required
Array of userReference strings. Every open order in gameID whose userReference is in this array is cancelled.

Response

array
Per-order cancel results. Same shape as Cancel an order.

Errors

Authorizations

Authorization
string
header
required

Pass your auth token in the Authorization header. The Bearer prefix is optional; the server also accepts a signed auth cookie or a token field in the request body.

Body

application/json
userReferences
string[]
required
gameID
string
required

Response

Per-order cancel results

data
object[]