---
title: "Create or replace an object by id"
method: PUT
path: "/api/v2/object/{id}"
tags: ["Object"]
---

# Create or replace an object by id

`PUT /api/v2/object/{id}`

## Request

- Base URL: `https://www.onlyworlds.com`
- URL: `https://www.onlyworlds.com/api/v2/object/{id}`
- Auth: API key in header `API-Key` and API key in header `API-Pin`

## Path parameters

- `id` string, uuid, required

## Headers

- `X-OW-Agent` string

## Request body

- ObjectWrite: A full object write (POST creates; PUT creates or fully replaces, resetting omitted fields to empty). Any key that is neither a field below nor an extension field (atlas_*, shadow_*, x_*) is a 422, including the server-managed type, created_at, updated_at and change_seq.
  - `id` string, uuid: POST: optional client-minted id (any RFC 4122 UUID; the server mints a UUIDv7 otherwise). PUT/PATCH: ignored, the path id wins.
  - `name` string, nullable, required: Name of the element. null stores ''.
  - `description` string, nullable: Any kind of details about the element. null stores ''.
  - `supertype` string, nullable: The top level category to which the element belongs. null stores ''.
  - `subtype` string, nullable: The sub level category through which the element is further classified. null stores ''.
  - `image_url` string, nullable: URL to an image representing the element. null stores ''.
  - `aesthetics` string, nullable: Appearance, design, or visual presentation of the object. null stores ''.
  - `utility` string, nullable: Intended purpose or primary use of the object. null stores ''.
  - `origins` string, nullable: Background or history of the object. null stores ''.
  - `weight` integer, nullable: Approximate or exact mass of the object, in the world's mass unit (World mass_unit).
  - `amount` integer, nullable: The number of identical units in this object entry.
  - `parent_object` string, uuid, nullable: Larger object that this one is part of or contained within. Links an Object: an existing one in this world.
  - `location` string, uuid, nullable: Physical place where the object is currently located or stored. Links a Location: an existing one in this world.
  - `language` string, uuid, nullable: Required to read, understand, or activate the object. Links a Language: an existing one in this world.
  - `materials` string[], nullable: The physical matter that constitutes the object. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.
  - `technology` string[], nullable: Mechanisms relating to the object's design or operation. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.
  - `effects` string[], nullable: Phenomena potentially triggered or emitted on object use. Links Phenomenon elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.
  - `abilities` string[], nullable: Abilities that the object grants or enables. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.
  - `consumes` string[], nullable: What might be used or depleted on object use. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.
  - `affinities` string[], nullable: Traits that resonate with or enhance the object's use, function, or effects. Links Trait elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.
  - `world` unknown
  - `created_by` unknown
  - `changed_by` unknown
  - `changed_via` unknown

## Response `200`

Replaced: the full element.

- Object: An object as the API returns it. Single links are an id or null, multi links an array of ids; extension fields appear inline. `?fields=` returns only the named keys, and `?expand=` replaces the named links' ids with ElementStub objects.
  - `type` 'object', required
  - `id` string, uuid, required
  - `name` string, required: Name of the element.
  - `description` string, required: Any kind of details about the element.
  - `supertype` string, required: The top level category to which the element belongs.
  - `subtype` string, required: The sub level category through which the element is further classified.
  - `image_url` string, required: URL to an image representing the element.
  - `aesthetics` string, required: Appearance, design, or visual presentation of the object.
  - `utility` string, required: Intended purpose or primary use of the object.
  - `origins` string, required: Background or history of the object.
  - `weight` integer, nullable, required: Approximate or exact mass of the object, in the world's mass unit (World mass_unit).
  - `amount` integer, nullable, required: The number of identical units in this object entry.
  - `parent_object` string, uuid, nullable, required: Larger object that this one is part of or contained within. An Object's id.
  - `location` string, uuid, nullable, required: Physical place where the object is currently located or stored. A Location's id.
  - `language` string, uuid, nullable, required: Required to read, understand, or activate the object. A Language's id.
  - `materials` string[], required: The physical matter that constitutes the object. Construct ids.
  - `technology` string[], required: Mechanisms relating to the object's design or operation. Construct ids.
  - `effects` string[], required: Phenomena potentially triggered or emitted on object use. Phenomenon ids.
  - `abilities` string[], required: Abilities that the object grants or enables. Ability ids.
  - `consumes` string[], required: What might be used or depleted on object use. Construct ids.
  - `affinities` string[], required: Traits that resonate with or enhance the object's use, function, or effects. Trait ids.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `change_seq` integer, required: The world change sequence at this element's last write.
  - `created_by` string, uuid, nullable, required: The world membership that created this element, or null when the world's owner did.
  - `changed_by` string, uuid, nullable, required: The world membership that last changed this element, or null when the world's owner (or the server) did, or no write has touched it since doors were recorded.
  - `changed_via` 'seat' | 'mcp' | 'declared' | 'api' | 'v1' | 'sync' | 'server' | 'null', nullable, required: The door of the last change: `seat` (an agent seat), `mcp` (the MCP server), `declared` (the request sent an X-OW-Agent header), `api`, `v1`, `sync` (the mobile app's sync) or `server` (the server, on its own behalf). The first three mean an agent made it. Null: no write since doors were recorded.
  - `known_of` true: Present, and true, only on an element this reader knows of but does not see whole: a guest or player reaches it only because its own Character's sheet links to it (one step out). Such a row keeps `id`, `type`, `name`, `description`, `supertype`, `subtype`, `image_url`, `created_at`, `updated_at` and `change_seq`, and its type's public fields (none for an object); every other field reads as unset (text "", numbers and single links null, multi links [], `created_by`, `changed_by` and `changed_via` null, no extension fields), its files are 404, and search matches only what it keeps. Absent: the element is whole. Any other grant (it names the reader's Character, the reader knows it, it is on the roster, the reader made it) makes it whole; a hidden element is never even a stub, whatever its public fields. Read-only: a write carrying `known_of` is refused (`known_of_not_writable`).

## Other responses

- `201`: Created: the full element.
- `400`: A link names an element that does not exist in this world (code invalid_link).
- `401`: Missing, invalid or revoked credential, or a wrong PIN (authentication_error; code key_revoked for a revoked key, invalid_credentials otherwise).
- `403`: The credential is valid but lacks the scope: a read key on a write route (permission_error). Or a contributor or guest key changed, replaced, relinked or deleted an element someone else created (code not_author); those members change only their own, and, for an agent seat the owner gave a Character, that Character (never deleting it).
- `409`: The id is held by an element in another world (id_conflict).
- `422`: Invalid request: unknown or read-only field, bad value, unknown query parameter, over-long text, extensions over the size cap (invalid_request); `param` names the culprit.
- `429`: Too many failed PIN attempts; see the Retry-After header (rate_limited). Or too many requests: over the request budget (code too_many_requests, type rate_limited): 300 requests a minute per key or account token, 60 a minute per address for a request with neither. Retry after the Retry-After header's seconds.
- `503`: The server is busy: every request slot stayed full for 10 s (code server_busy, type api_error). Retry after the Retry-After header's seconds.

## Changes

- **2026-10-20** `78df39c4c62e`: 7 warning
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `400`
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `401`
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `403`
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `409`
  - …3 more
- **2026-10-20** `4dd5b1cd0687`: 14 warning, 2 info
  - added the new `character_taken` enum value to the `error/code` response property for the response status `400`
  - added the new `character_taken` enum value to the `error/code` response property for the response status `401`
  - added the new `character_taken` enum value to the `error/code` response property for the response status `403`
  - added the new `character_taken` enum value to the `error/code` response property for the response status `409`
  - …12 more

[Operation history](https://skmtc.dev/onlyworlds/apis/onlyworlds-api/changes/api/v2/object/:id/put.md)

---

[API](https://skmtc.dev/onlyworlds/apis/onlyworlds-api.md) · [All operations](https://skmtc.dev/onlyworlds/apis/onlyworlds-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onlyworlds/apis/onlyworlds-api/revisions/78df39c4c62e?raw)