Activate or deactivate a contract

patch

https://api.qfp.quantnetwork.net/api/contracts/{assetId}

Sets the status of the contract for assetId, between ACTIVE and INACTIVE only. Contracts are deactivated, not deleted, so an assetId is never released for reuse. While a contract is INACTIVE, no new account or token operation can be raised against the asset.

PENDING and FAILED belong to the deployment lifecycle and only it writes them: a contract currently in either is refused 400, as is a request naming either as the target. A PATCH can neither declare a deployment confirmed nor park an asset.

Path Params

assetId

string

required

length ≤ 16

The asset whose contract status is being changed, case-insensitive.

Body Params

The organisation is taken from the access token. A tenantId sent in the body is ignored.

status

string

enum

required

Status of a registered contract. PENDING and FAILED belong to the deployment lifecycle: a deploy registers the contract PENDING at its computed address, a confirmation makes it ACTIVE, and every other terminal ending makes it FAILED, which frees the asset to deploy again. ACTIVE/INACTIVE remain the operator-settable soft flag.

Allowed:

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200The updated contract.

400The status is missing or invalid, or the contract is in — or the request names — a deployment-lifecycle status (PENDING, FAILED).

401Returned once authentication is enforced, when the request carries no Authorization header or an unresolvable token. (planned — not returned today, see the API description.)

404No contract exists for that assetId.

500An unexpected error occurred while handling the request.