PATCH /v2/journal/accounts/{id}

Update a journal account (JSON Merge Patch)

journal_patchAccount

Changes some fields of one journal account and returns the updated account. An id you do not have returns 404 not_found.

Path parameters

id string required: Account id

Request body

The contract does not describe a body schema for this operation; the notes on this page give its fields.

Details

The body follows JSON Merge Patch (RFC 7396): a field you leave out is unchanged, an explicit null clears it, and a value sets it. For example, {"broker": null} clears the broker.

Response

Prices are dollars, timestamps epoch milliseconds, strikes integer thousandths of a dollar; null means unknown. Units →

200application/json

The updated account in data

object

A successful response: the payload consumers parse plus response metadata. data shapes are the platform types — never reshaped by the envelope.

data object required

A journal account (normalized; minimal fields).

broker string nullable

id string required

name string

meta object required

Response metadata.

caps object nullable

meta.caps — the entitlement caps that shaped this response. applied lists the caps that actually changed it (for example range_clamped).

applied array<string> required

Which caps actually shaped this response (e.g. range_clamped). Empty = nothing was clamped.

darkpool boolean nullable

Whether this account can use Off-Exchange in the site.

flow boolean nullable

Whether the OPRA option-flow capability (flow) is granted to this principal in the app: site Pro plus a CBOE non-professional attestation (never on an itm_ key). Emitted explicitly — true and false — by the account endpoints, so the app reads the grant instead of inferring it from tier and attestation; absent on routes that do not report it.

gexDepth string nullable

GEX data depth when the route reports it. Camel-cased to match the browser capability bundle; absent on unrelated routes.

tier string required

The tier the request was served under.

cursor string nullable

Opaque continuation cursor (pass back as ?cursor=); absent when there is nothing more to read.

plane string nullable

Which serving tier answered the read (meta.plane). Informational provenance: treat it as an opaque label, because new values may appear.

Errors

Every error is the JSON error envelope; branch on error.code.

Status	Meaning
401	`unauthenticated`
404	`not_found`

Request

curl -sS -X PATCH "https://api.itmatrixhq.com/v2/journal/accounts/acct-main" \
  -H "Authorization: Bearer $ITM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import httpx

response = httpx.patch(
    "https://api.itmatrixhq.com/v2/journal/accounts/acct-main",
    json={},  # the fields under "Request body" above
    headers={"Authorization": f"Bearer {os.environ['ITM_API_KEY']}"},
    timeout=30,
)
print(response.status_code, response.json())

import os
import itmatrix as itm

patch = {}  # the fields under "Request body" above

with itm.ITMClient(api_key=os.environ["ITM_API_KEY"]) as client:
    result = client.journal.patch_account("acct-main", patch)
    print(result.status, result.data)

const url = new URL("https://api.itmatrixhq.com/v2/journal/accounts/acct-main");

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.ITM_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}), // the fields under "Request body" above
});
console.log(response.status, await response.json());

import { ITMClient } from "@itmatrixhq/core";

const client = new ITMClient({ apiKey: process.env.ITM_API_KEY });
const patch = {}; // the fields under "Request body" above
const result = await client.journal.patchAccount("acct-main", patch);
console.log(result.status, result.data);