Family

Update part of a family

Changed on
patch/api/v2/family/{id}

Request

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

Path parameters

idstring uuid required

The family's id (a malformed id is a 422).

Headers

If-Matchstring

Apply only if the element's change_seq is still this number (quoted or bare; * or no header means unconditional). When the element has moved, 412 precondition_failed with the live element as current beside the envelope; nothing is written and nothing is merged.

X-OW-Agentstring

Send it (any non-empty value) when an agent makes this write: the change is recorded with changed_via declared (a delete's tombstone with deleted_via). An agent seat's key and MCP are recorded as agent-made without it. The value is never stored.

Request body

idstring uuid

POST: optional client-minted id (any RFC 4122 UUID; the server mints a UUIDv7 otherwise). PUT/PATCH: ignored, the path id wins.

namestring nullable

Name of the element. null stores ''.

descriptionstring nullable

Any kind of details about the element. null stores ''.

supertypestring nullable

The top level category to which the element belongs. null stores ''.

subtypestring nullable

The sub level category through which the element is further classified. null stores ''.

image_urlstring nullable

URL to an image representing the element. null stores ''.

spiritstring nullable

The core values or shared ethos that the family embodies. null stores ''.

historystring nullable

Background or origin story of the family. null stores ''.

reputationstring nullable

Current social, political, or general standing of the family. null stores ''.

traditionsstring[] nullable

Cultural practices, symbols, or customs overseen by the family. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

traitsstring[] nullable

Traits possibly found among members of the family. Links Trait elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

abilitiesstring[] nullable

Abilities or special qualities possibly present in the family. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

languagesstring[] nullable

Languages spoken by, or associated with the family. Links Language elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

ancestorsstring[] nullable

Notable forebears or historic characters in the family's lineage. Links Character elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

estatesstring[] nullable

Key locations owned, governed, or symbolically tied to the family. Links Location elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

governsstring[] nullable

Institutions administered or managed by the family. Links Institution elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

heirloomsstring[] nullable

Important objects or artifacts handed down by the family. Links Object elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

creaturesstring[] nullable

Creatures owned, bonded to, or representing the family. Links Creature elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

worldunknown
created_byunknown
changed_byunknown
changed_viaunknown

Response

Updated: the full element.

type'family' required
idstring uuid required
namestring required

Name of the element.

descriptionstring required

Any kind of details about the element.

supertypestring required

The top level category to which the element belongs.

subtypestring required

The sub level category through which the element is further classified.

image_urlstring required

URL to an image representing the element.

spiritstring required

The core values or shared ethos that the family embodies.

historystring required

Background or origin story of the family.

reputationstring required

Current social, political, or general standing of the family.

traditionsstring[] required

Cultural practices, symbols, or customs overseen by the family. Construct ids.

traitsstring[] required

Traits possibly found among members of the family. Trait ids.

abilitiesstring[] required

Abilities or special qualities possibly present in the family. Ability ids.

languagesstring[] required

Languages spoken by, or associated with the family. Language ids.

ancestorsstring[] required

Notable forebears or historic characters in the family's lineage. Character ids.

estatesstring[] required

Key locations owned, governed, or symbolically tied to the family. Location ids.

governsstring[] required

Institutions administered or managed by the family. Institution ids.

heirloomsstring[] required

Important objects or artifacts handed down by the family. Object ids.

creaturesstring[] required

Creatures owned, bonded to, or representing the family. Creature ids.

created_atstring date-time required
updated_atstring date-time required
change_seqinteger required

The world change sequence at this element's last write.

created_bystring uuid nullable required

The world membership that created this element, or null when the world's owner did.

changed_bystring 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_oftrue

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; 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 its name and description. 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.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the // response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the // response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status