Disable or Enable order

Enable or disable an order template by flipping the active flag.

PATCH /order/{order_id}/toggle

cURL

curl --request PATCH \
  --url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx/toggle \
  --header 'x-api-key: <api_key>'

200 - Success (activated)

{
  "statusCode": 200,
  "success": true,
  "status": "order_activated",
  "message": "Order activated successfully.",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
    "active": true
  }
}

x-api-key · string · required

Your StarkFi API key. You can find it in your dashboard.

order_id · string · required

Order CUID.

cURL

curl --request PATCH \
  --url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx/toggle \
  --header 'x-api-key: <api_key>'

200 - Success (activated)

{
  "statusCode": 200,
  "success": true,
  "status": "order_activated",
  "message": "Order activated successfully.",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
    "active": true
  }
}

Response

data.id · string · required

Order id that was toggled.

data.active · boolean · required

New active value after the toggle.