> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.immix.xyz/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.immix.xyz/_mcp/server.

# Update an instance's document

PUT /algos/instances/{id}/config
Content-Type: application/json

Stages a new config document for the instance (`algos:manage`), legal in every state but `DELETED` — while it runs too. `If-Match` is the instance's `configSeq` (absent or `*` is unconditional; stale is 412 with `currentVersion`). Answers 200 with the staged document; the engine's verdict is a later state, read on its documents. One document awaits a verdict at a time (409 `CONFIG_PENDING`).

Reference: https://docs.immix.xyz/api-reference/rest-api/algos/update-instance-config

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `id` (integer, required) — The instance's id — a positive 32-bit integer the platform minted; the value an algo's orders carry as `algoInstanceId`.

### Headers

- `Idempotency-Key` (string, required) — Required on every write: a URL-safe string of 1 to 64 characters from `[A-Za-z0-9._~-]` (a UUID fits), scoped to you. It names one operation on one record, ever: a retry replays the stored outcome (`Idempotent-Replay: true`) or attaches to the live one, and reuse on another record refuses 409 `IDEMPOTENCY_KEY_REUSED`. Missing or malformed, 400.
- `If-Match` (string, optional) — The `ETag` the read minted, quoted or bare; absent or `*` is unconditional; a weak validator refuses 400 `INVALID_IF_MATCH`. A stale value answers 412 `VERSION_CONFLICT` with `currentVersion` and a fresh `ETag`: re-read, reapply, retry. Send it — every write restates the whole record, so an unconditional write overwrites every field from your copy, and an amend against a pending proposal replaces that proposal.

### Body (application/json)

This endpoint expects an object.

- `remark` (string, required) — Why — required on every change, at most 256 bytes of UTF-8.
- `document` (string, required) — The new config document: JSON with comments, one object the version's params schema types whole, each reference an id or, through the trading gateway, a name the gateway replaces with its id before the command is sent, as on the create; at most 6144 bytes of UTF-8 as written and as sent, and its distinct references at most 1280 bytes, 4 an account and 8 an instrument.
- `instanceId` (integer, optional) — The instance whose document changes.
- `expectedConfigSeq` (integer, optional, nullable) — The configSeq this write was computed against; 0 = unconditional. A mismatch is refused with the current configSeq in the detail.
- `commandKey` (string, optional) — The command's idempotency key, 1 to 64 characters of letters, digits, dot, underscore, tilde and hyphen; a replay restates the earlier answer.

## Response

### 200

The document as staged — `STAGED`; the engine's verdict is a later change, read on `GET /algos/instances/{id}/configs/{seq}` — with the answering change's position and, on a replayed key, `Idempotent-Replay`. No `ETag`: a document carries no version.

- `accountIds` (list of integer, required) — Every account the document references, once each, ascending — the accounts the instance may trade.
- `commandKey` (string, required) — The write's `Idempotency-Key`, as sent.
- `configSeq` (integer, required) — The document's sequence number on its instance: 1 for the document the instance was created with, one more for every accepted write.
- `detail` (string, required) — The engine's reason where it refused the document; empty otherwise.
- `document` (string, required) — The document as authored, comments included — at most 6144 bytes of UTF-8.
- `globalSequence` (string, required) — The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
- `instanceId` (integer, required) — The instance the document belongs to.
- `instrumentIds` (list of string, required) — Every instrument the document references, once each, ascending — 64-bit ids as decimal strings.
- `orgId` (integer, required) — The organisation that owns the instance.
- `outcome` (enum, required) — `STAGED` until the engine answers, then `APPLIED` or `REFUSED`; `PENDING_APPROVAL` is reserved and never served today. The value set is append-only: read an unknown name as `UNKNOWN`.
  - Allowed values: `UNKNOWN`, `STAGED`, `APPLIED`, `REFUSED`, `PENDING_APPROVAL`
- `remark` (string, required) — The submitter's remark.
- `submittedAtNs` (string, required) — When it was submitted — epoch nanoseconds as a decimal string.
- `outcomeAtNs` (string, optional, nullable) — When the engine's verdict landed — epoch nanoseconds as a decimal string; null while staged.
- `pendingByUserId` (integer, optional, nullable) — Reserved; always null.
- `userId` (integer, optional, nullable) — The user who submitted it.
- `unscaled` (boolean, optional, deprecated) — Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.

## Errors

### 400 Update Instance Config Algos Request Bad Request Error

Refused at the door — nothing reached the platform and the key was not journaled: a missing or malformed `Idempotency-Key` or `If-Match`, malformed JSON, a body `userId`, a body restating the path or `If-Match` differently, a money string off its `pattern` (an exponent, a plus sign, a bare point, surrounding whitespace) or past its `maxLength`, or one no value here can state (over 18 fractional digits, or past a 64-bit integer at its own scale), or any other value outside the schema.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 401 Update Instance Config Algos Request Unauthorized Error

No bearer token, or one that does not verify.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 403 Update Instance Config Algos Request Forbidden Error

Authenticated, but not admitted. `FORBIDDEN_PRINCIPAL`: a token with no `org_id`, a non-ASCII `org_id` or `sub`, a disabled user, or a local binding with no user. `AWAITING_ADMISSION`: your user is not yet admitted — every route but `GET /me` answers this until an administrator admits you. `ORG_NOT_ACTIVE`: your organisation is suspended, pending activation, retired or unregistered. The record owners' 403s (`CAPABILITY_DENIED`, `SELF_APPROVAL`, `NOT_PROPOSER`, …) are refusals on the platform's stream: they carry the position header, and a retried key replays them with `Idempotent-Replay`.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 404 Update Instance Config Algos Request Not Found Error

The door's `NOT_FOUND`: no such instance in your organisation — another organisation's is indistinguishable from an absent one; the position header says as of when, and nothing was journaled. Or the platform's own refusal, a fact on its stream that a retried key replays: `UNKNOWN_INSTANCE` (the instance vanished in the catch-up window) and, on a create, `UNKNOWN_ALGO_VERSION` (no catalog row under the version the body named).

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 409 Update Instance Config Algos Request Conflict Error

The record owner's refusal, by class: 409 for a state or uniqueness refusal, 422 for a field or reference refusal — a fact on the platform's stream, so it carries the position header and a retried key replays it. The same statuses carry door refusals, never journaled — a retry takes fresh: 409 `IDEMPOTENCY_KEY_REUSED`; 422 for a name nothing here holds, `INSTRUMENT_NOT_LIVE` or `ACCOUNT_NOT_ACTIVE` on `POST /orders` and `REFERENCE_UNKNOWN_INSTRUMENT` or `REFERENCE_UNKNOWN_ACCOUNT` in an algo document — each the owner's code for an id it rejects; a key the member holds answers as its retry.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 412 Update Instance Config Algos Request Precondition Failed Error

`If-Match` is stale (`CONFIG_SEQ_CONFLICT`): another document has been staged since the read — the envelope carries `currentVersion`, the instance's current `configSeq`, and the `ETag` header the same — re-read, reapply, retry. A fact on the platform's stream: a retried key replays it with `Idempotent-Replay`.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 413 Update Instance Config Algos Request Content Too Large Error

`DOCUMENT_TOO_LARGE`: the config document is past the platform's bound (6144 bytes of UTF-8) — refused at the door on the text's bytes — as written, or once its names are replaced by their ids — nothing sent, the key retries fresh; the platform answers the same code to the same bytes. Or `TOO_LARGE`, the platform's refusal of the whole command's size. Neither is journaled.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 422 Update Instance Config Algos Request Unprocessable Entity Error

The record owner's refusal, by class: 409 for a state or uniqueness refusal, 422 for a field or reference refusal — a fact on the platform's stream, so it carries the position header and a retried key replays it. The same statuses carry door refusals, never journaled — a retry takes fresh: 409 `IDEMPOTENCY_KEY_REUSED`; 422 for a name nothing here holds, `INSTRUMENT_NOT_LIVE` or `ACCOUNT_NOT_ACTIVE` on `POST /orders` and `REFERENCE_UNKNOWN_INSTRUMENT` or `REFERENCE_UNKNOWN_ACCOUNT` in an algo document — each the owner's code for an id it rejects; a key the member holds answers as its retry.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 429 Update Instance Config Algos Request Too Many Requests Error

Shed at once: `INBOX_FULL` or `IN_FLIGHT_FULL` (this member's bounds; nothing queued, the key not journaled), the intake's `RATE_LIMITED`, or the orders owner's `RATE_CEILING` (the organisation's per-minute ceiling — a refusal on the stream, replayed like any). `Retry-After` says when.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 500 Update Instance Config Algos Request Internal Server Error

The gateway failed to serve (`INTERRUPTED`, `INTERNAL_ERROR`, `PROJECTION_MISS`); the operation record, if one exists, is still readable.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 503 Update Instance Config Algos Request Service Unavailable Error

This member cannot serve the algos surface now: `NOT_PRIMED` — it is still catching up; retry shortly — or `ALGOS_UNAVAILABLE` — it is deployed without the surface, because the algos owner is not released into its environment yet, so no instance is readable or commandable here and a retry changes nothing; every other route is unaffected. On a write also `NOT_SERVING`, `OWNER_ABSENT`, or the platform's own outcome for a command lost in transit — nothing journaled; retry against a serving member.

- `error` (ErrorError, required)
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

## Types

### ErrorError

- `code` (string, required) — The code to branch on — stable and append-only: treat one you do not know by its HTTP status. The gateway's own: - 400: `MALFORMED_REQUEST`, `MISSING_IDEMPOTENCY_KEY`, `INVALID_IDEMPOTENCY_KEY`, `INVALID_IF_MATCH` - 401: `UNAUTHENTICATED` - 403: `FORBIDDEN_PRINCIPAL`, `AWAITING_ADMISSION`, `ORG_NOT_ACTIVE`, `CAPABILITY_DENIED` (the credential intake) - 404: `NOT_FOUND`, `UNKNOWN_OPERATION` - 409: `IDEMPOTENCY_KEY_REUSED`, `INTAKE_KEY_REUSED` - 413: `TOO_LARGE`, `PAYLOAD_TOO_LARGE`, `DOCUMENT_TOO_LARGE` - 422: a name nothing here holds: `INSTRUMENT_NOT_LIVE`, `ACCOUNT_NOT_ACTIVE` (`POST /orders`), `REFERENCE_UNKNOWN_INSTRUMENT`, `REFERENCE_UNKNOWN_ACCOUNT` (an algo document); `VENUE_UNSUPPORTED`; `SCALE_UNKNOWN` (retired at `0.3.4`) - 429: `INBOX_FULL`, `IN_FLIGHT_FULL`, `RATE_LIMITED` - 500: `INTERRUPTED`, `INTERNAL_ERROR`, `PROJECTION_MISS` - 503: `NOT_PRIMED`, `NOT_SERVING`, `OWNER_ABSENT`, `INTAKE_UNAVAILABLE`, `BALANCES_UNAVAILABLE`, `ALGOS_UNAVAILABLE`, `LOST`, `REJECTED_NOT_REGISTERED`, `REJECTED_NOT_ACTIVE` The record owners' refusals ride verbatim — `OrgRegisterRejected.reason`, `OrderRejected.reason` and `AlgoRejected.reason` list them; the guide maps each to its status.
- `message` (string, optional) — Free text for humans; may change without notice — never parse it.

## Examples

**Request**

```json
{
  "remark": "remark",
  "document": "document"
}
```

**Response**

```json
{
  "accountIds": [
    1
  ],
  "commandKey": "commandKey",
  "configSeq": 1,
  "detail": "detail",
  "document": "document",
  "globalSequence": "globalSequence",
  "instanceId": 1,
  "instrumentIds": [
    "instrumentIds"
  ],
  "orgId": 1,
  "outcome": "UNKNOWN",
  "remark": "remark",
  "submittedAtNs": "submittedAtNs",
  "outcomeAtNs": "outcomeAtNs",
  "pendingByUserId": 1,
  "userId": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/algos/instances/1/config"

payload = {
    "remark": "remark",
    "document": "document"
}
headers = {
    "Idempotency-Key": "Idempotency-Key",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/algos/instances/1/config';
const options = {
  method: 'PUT',
  headers: {
    'Idempotency-Key': 'Idempotency-Key',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"remark":"remark","document":"document"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/algos/instances/1/config"

	payload := strings.NewReader("{\n  \"remark\": \"remark\",\n  \"document\": \"document\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Idempotency-Key", "Idempotency-Key")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/algos/instances/1/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = 'Idempotency-Key'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"remark\": \"remark\",\n  \"document\": \"document\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.example.com/algos/instances/1/config")
  .header("Idempotency-Key", "Idempotency-Key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"remark\": \"remark\",\n  \"document\": \"document\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.example.com/algos/instances/1/config', [
  'body' => '{
  "remark": "remark",
  "document": "document"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => 'Idempotency-Key',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/algos/instances/1/config");
var request = new RestRequest(Method.PUT);
request.AddHeader("Idempotency-Key", "Idempotency-Key");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"remark\": \"remark\",\n  \"document\": \"document\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Idempotency-Key": "Idempotency-Key",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "remark": "remark",
  "document": "document"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/algos/instances/1/config")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```