characters

Patch Character

Partially update a character.

Requires write access to the associated world.

patch/v1/characters/{character_id}

Request

  • Base URL: https://api.myarchivist.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.myarchivist.ai/v1/characters/{character_id}
  • Auth: HTTP bearer

Path parameters

character_idstring required

Headers

x-api-keystring nullable

Request body

character_namestring nullable
character_aliasstring nullable
character_aliasesstring[] nullable
player_namestring nullable
player_handlestring nullable
descriptionstring nullable
backstorystring nullable
typestring nullable
imagestring nullable
speaker_idstring nullable

Response

Successful Response

created_atstring date-time required
updated_atstring date-time nullable
idstring required
character_namestring required
character_aliasstring nullable
character_aliasesstring[]
player_namestring nullable
player_handlestring nullable
descriptionstring nullable
backstorystring nullable
typestring
imagestring nullable
campaign_idstring required
tcg_imagestring nullable
mergeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.