curl --request PATCH \
--url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx/toggle \
--header 'x-api-key: <api_key>'
const orderId = "clxxxxxxxxxxxxxxxxxxxxxxxx";
const response = await fetch(
`https://api.starkfi.io/order/${orderId}/toggle`,
{ method: "PATCH", headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
order_id = "clxxxxxxxxxxxxxxxxxxxxxxxx"
response = requests.patch(
f"https://api.starkfi.io/order/{order_id}/toggle",
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "order_activated",
"message": "Order activated successfully.",
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": true
}
}
{
"statusCode": 200,
"success": true,
"status": "order_deactivated",
"message": "Order deactivated successfully.",
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": false
}
}
{
"statusCode": 404,
"success": false,
"status": "order_not_found",
"message": "Order not found."
}
Orders
Disable or Enable order
Enable or disable an order template by flipping the active flag.
PATCH
/
order
/
{order_id}
/
toggle
curl --request PATCH \
--url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx/toggle \
--header 'x-api-key: <api_key>'
const orderId = "clxxxxxxxxxxxxxxxxxxxxxxxx";
const response = await fetch(
`https://api.starkfi.io/order/${orderId}/toggle`,
{ method: "PATCH", headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
order_id = "clxxxxxxxxxxxxxxxxxxxxxxxx"
response = requests.patch(
f"https://api.starkfi.io/order/{order_id}/toggle",
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "order_activated",
"message": "Order activated successfully.",
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": true
}
}
{
"statusCode": 200,
"success": true,
"status": "order_deactivated",
"message": "Order deactivated successfully.",
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": false
}
}
{
"statusCode": 404,
"success": false,
"status": "order_not_found",
"message": "Order not found."
}
string
required
Order CUID.
curl --request PATCH \
--url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx/toggle \
--header 'x-api-key: <api_key>'
const orderId = "clxxxxxxxxxxxxxxxxxxxxxxxx";
const response = await fetch(
`https://api.starkfi.io/order/${orderId}/toggle`,
{ method: "PATCH", headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
order_id = "clxxxxxxxxxxxxxxxxxxxxxxxx"
response = requests.patch(
f"https://api.starkfi.io/order/{order_id}/toggle",
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "order_activated",
"message": "Order activated successfully.",
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": true
}
}
{
"statusCode": 200,
"success": true,
"status": "order_deactivated",
"message": "Order deactivated successfully.",
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": false
}
}
{
"statusCode": 404,
"success": false,
"status": "order_not_found",
"message": "Order not found."
}
Response
string
required
Order id that was toggled.
boolean
required
New
active value after the toggle.⌘I
.png?fit=max&auto=format&n=I_v6ul4JDafNKFQP&q=85&s=f0ad25536f8a3ca42331fcff88ab2b26)