Skip to main content
POST
/
v1
/
broker
/
order_enum
/
{enum_id}
/
archive
Archive an order enum
curl --request POST \
  --url https://api.orderly.org/v1/broker/order_enum/{enum_id}/archive \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "timestamp": 1702989203989,
  "data": {
    "enum_id": "STRATEGY_DCA",
    "status": "archived",
    "archived_at": 1710400000000,
    "message": "Order enum archived. Existing orders will continue processing. Permanently purged after 30 days."
  }
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Path Parameters

​
enum_id
string
required

Enum ID

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989

​
data
object