Skip to navigation

Update your name

Renames you under your row’s version (If-Match, from GET /me). Your name is free text another member may share; any active member may change their own, no capability needed. The body states the name alone: one stating your capabilities or sign-in is 400 (PUT /users/{id} changes those); an API key is 403 FORBIDDEN_PRINCIPAL. Live at once, no approval; answers your row as GET /me does.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringRequired

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-MatchstringRequired

Required on every entity write: the ETag the read minted, quoted or bare — the version this write was computed against — or * to write unconditionally on purpose, except on a notification endpoint’s approval, which refuses * 400 INVALID_IF_MATCH. Absent is 428 PRECONDITION_REQUIRED; a weak validator 400 INVALID_IF_MATCH; a stale value 412 VERSION_CONFLICT (CONFIG_SEQ_CONFLICT on an algo’s config write) with currentVersion and a fresh ETag: re-read, reapply, retry. A * write overwrites every field from your copy, a colleague’s amend since your read included.

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Request

This endpoint expects an object.
namestringRequired

At most 128 bytes; longer refuses INVALID_FIELD.

Response

Your row as the platform now holds it after the rename — the same MeRow GET /me serves, with the answering change’s position, the row’s ETag and, on a replayed key, Idempotent-Replay.

actorobject

Who you are: USER with your user id, or API_KEY with the key’s id.

apiKeyIdinteger or null

Your key id — an API key’s; null for a member.

capabilitieslist of enums

Your capabilities, as your row serves them: scope strings in declared order; empty = none.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

lastActiveAtNsstring or nullformat: "^[0-9]+$"

When the principal was last seen acting — its last admitted request on this API (one a read replica serves is not recorded), or its open trading socket — epoch nanoseconds at a five-minute grain: a request inside five minutes of the mark need not move it, so read it as active within five minutes of this time. null while no mark is recorded: the principal has not acted since marks were first kept (0.71.0), or ever. A mark beside the row, not a field of it: it moves no version and no ETag.

namestring

Your platform name — a member’s, or the key’s name as issued.

orgIdinteger

Membership — stamped by the owner from the actor’s org; an organisation’s first administrator belongs to the organisation its creation mints.

orgNamestring

The organisation’s name: unique among live organisations when it is created, a label from then on — an organisation renames itself, and two may carry one name. At most 128 bytes; longer refuses INVALID_FIELD.

statusenum

Your standing: ACTIVE — the only standing this route answers; a DISABLED member or key is refused 403 FORBIDDEN_PRINCIPAL at admission.

Allowed values:
userIdinteger or null

Your user id — a member’s; null for an API key.

versionstringformat: "^-?[0-9]+$"

Your row’s version as a decimal string — a member’s user row’s, the key’s own on an API key. PUT /me takes it as If-Match, quoted as the ETag carries it: "<version>".

Errors

400
Update Me Users Request Bad Request Error
401
Update Me Users Request Unauthorized Error
403
Update Me Users Request Forbidden Error
409
Update Me Users Request Conflict Error
412
Update Me Users Request Precondition Failed Error
413
Update Me Users Request Content Too Large Error
422
Update Me Users Request Unprocessable Entity Error
428
Update Me Users Request Precondition Error
429
Update Me Users Request Too Many Requests Error
500
Update Me Users Request Internal Server Error
503
Update Me Users Request Service Unavailable Error