Skip to content

API Reference / Filter sets

Delete a filter set

Soft-deletes the filter set identified by the given ID so it can no longer be referenced by new contracts. Every live contract and filter set that references it keeps a copy of its rules in place of the reference, saved as an edit by the caller in the same transaction, so they select exactly the same items as before.

POST/contracts.v1.Contracts/DeleteFilterSet

Request body

application/jsonRequired

Request to delete a filter set. Each live contract and filter set referencing it has the reference replaced by a copy of the filter set's rules, as an edit by the caller, so it selects the same items.

filterSetId?string

Opaque 16-byte identifier of the filter set to delete, base64-encoded in JSON.

Format"byte" base64

Response body

application/json

Success

No fields.

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/DeleteFilterSet" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filterSetId": "EBESExQVFhcYGRobHB0eHw=="
  }'
{}