Skip to content

PersonUpdateDto

Endpoints · All schemas

FieldRequiredDescription
birthDateNoPerson date of birth
colorNoPerson color (hex)
featureFaceAssetIdNoAsset ID used for feature face thumbnail
isFavoriteNoMark as favorite
isHiddenNoPerson visibility (hidden)
nameNoPerson name

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "birthDate": {
      "description": "Person date of birth",
      "format": "date",
      "nullable": true,
      "type": "string"
    },
    "color": {
      "description": "Person color (hex)",
      "nullable": true,
      "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
      "type": "string"
    },
    "featureFaceAssetId": {
      "description": "Asset ID used for feature face thumbnail",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "isFavorite": {
      "description": "Mark as favorite",
      "type": "boolean"
    },
    "isHidden": {
      "description": "Person visibility (hidden)",
      "type": "boolean"
    },
    "name": {
      "description": "Person name",
      "type": "string"
    }
  },
  "type": "object"
}