--- title: "Update Entity" method: PUT path: "/v1/entities/{id}" tags: ["Entities"] --- # Update Entity `PUT /v1/entities/{id}` ## Path parameters - `id` string, required ## Request body - RepoEntityUpdate - `archived` boolean - `assetId` string - `description` string - `entityTypeId` string - `fields` RepoEntityFieldData[] - `booleanValue` boolean - `id` string - `name` string - `numberValue` integer - `textValue` string - `type` string - `id` string - `insured` boolean - `lifetimeWarranty` boolean — Warranty - `manufacturer` string - `modelNumber` string - `name` string, required - `notes` string — Extras - `parentId` string, nullable - `purchaseDate` string — Purchase - `purchaseFrom` string - `purchasePrice` number, nullable - `quantity` number - `serialNumber` string — Identifications - `soldDate` string — Sold - `soldNotes` string - `soldPrice` number, nullable - `soldTo` string - `syncChildEntityLocations` boolean - `tagIds` string[] — Edges - `warrantyDetails` string - `warrantyExpires` string ## Response `200` OK - RepoEntityOut - `archived` boolean - `assetId` string - `attachments` RepoItemAttachment[] - `createdAt` string - `id` string - `mimeType` string - `path` string - `primary` boolean - `thumbnail` EntAttachment - `created_at` string — CreatedAt holds the value of the "created_at" field. - `edges` EntAttachmentEdges - `entity` EntEntity - `archived` boolean — Archived holds the value of the "archived" field. - `asset_id` integer — AssetID holds the value of the "asset_id" field. - `created_at` string — CreatedAt holds the value of the "created_at" field. - `description` string — Description holds the value of the "description" field. - `edges` EntEntityEdges - `attachments` EntAttachment[] — Attachments holds the value of the attachments edge. - `children` EntEntity[] — Children holds the value of the children edge. - `entity_type` EntEntityType - … - `fields` EntEntityField[] — Fields holds the value of the fields edge. - … - `group` EntGroup - … - `maintenance_entries` EntMaintenanceEntry[] — MaintenanceEntries holds the value of the maintenance_entries edge. - … - `parent` EntEntity — recursive - `tag` EntTag[] — Tag holds the value of the tag edge. - … - `id` string — ID of the ent. - `import_ref` string — ImportRef holds the value of the "import_ref" field. - `insured` boolean — Insured holds the value of the "insured" field. - `lifetime_warranty` boolean — LifetimeWarranty holds the value of the "lifetime_warranty" field. - `manufacturer` string — Manufacturer holds the value of the "manufacturer" field. - `model_number` string — ModelNumber holds the value of the "model_number" field. - `name` string — Name holds the value of the "name" field. - `notes` string — Notes holds the value of the "notes" field. - `purchase_date` string — PurchaseDate holds the value of the "purchase_date" field. - `purchase_from` string — PurchaseFrom holds the value of the "purchase_from" field. - `purchase_price` number — PurchasePrice holds the value of the "purchase_price" field. - `quantity` number — Quantity holds the value of the "quantity" field. - `serial_number` string — SerialNumber holds the value of the "serial_number" field. - `sold_date` string — SoldDate holds the value of the "sold_date" field. - `sold_notes` string — SoldNotes holds the value of the "sold_notes" field. - `sold_price` number — SoldPrice holds the value of the "sold_price" field. - `sold_to` string — SoldTo holds the value of the "sold_to" field. - `sync_child_entity_locations` boolean — SyncChildEntityLocations holds the value of the "sync_child_entity_locations" field. - `updated_at` string — UpdatedAt holds the value of the "updated_at" field. - `warranty_details` string — WarrantyDetails holds the value of the "warranty_details" field. - `warranty_expires` string — WarrantyExpires holds the value of the "warranty_expires" field. - `thumbnail` EntAttachment — recursive - `id` string — ID of the ent. - `mime_type` string — MimeType holds the value of the "mime_type" field. - `path` string — Path holds the value of the "path" field. - `primary` boolean — Primary holds the value of the "primary" field. - `title` string — Title holds the value of the "title" field. - `type` 'attachment' | 'photo' | 'manual' | 'warranty' | 'attachment' | 'receipt' | 'thumbnail' - `updated_at` string — UpdatedAt holds the value of the "updated_at" field. - `title` string - `type` string - `updatedAt` string - `children` RepoEntitySummary[] — Container-specific fields (for entities whose entity_type.is_location = true) - `archived` boolean - `assetId` string - `createdAt` string - `description` string - `entityType` RepoEntityTypeSummary - `createdAt` string - `defaultTemplate` RepoEntityTemplateSummary - `createdAt` string - `description` string - `id` string - `name` string - `updatedAt` string - `defaultTemplateId` string - `description` string - `icon` string - `id` string - `isLocation` boolean - `name` string - `updatedAt` string - `id` string - `imageId` string, nullable - `insured` boolean - `itemCount` number — Container-specific (populated when querying locations) - `name` string - `parent` RepoEntitySummary — recursive - `purchasePrice` number - `quantity` number - `soldDate` string — Sale details - `tags` RepoTagSummary[] - `color` string - `createdAt` string - `description` string - `icon` string - `id` string - `name` string - `parentId` string, nullable - `updatedAt` string - `thumbnailId` string, nullable - `updatedAt` string - `createdAt` string - `description` string - `entityType` RepoEntityTypeSummary - `createdAt` string - `defaultTemplate` RepoEntityTemplateSummary - `createdAt` string - `description` string - `id` string - `name` string - `updatedAt` string - `defaultTemplateId` string - `description` string - `icon` string - `id` string - `isLocation` boolean - `name` string - `updatedAt` string - `fields` RepoEntityFieldData[] - `booleanValue` boolean - `id` string - `name` string - `numberValue` integer - `textValue` string - `type` string - `id` string - `imageId` string, nullable - `insured` boolean - `itemCount` number — Container-specific (populated when querying locations) - `lifetimeWarranty` boolean — Warranty - `location` RepoEntitySummary - `archived` boolean - `assetId` string - `createdAt` string - `description` string - `entityType` RepoEntityTypeSummary - `createdAt` string - `defaultTemplate` RepoEntityTemplateSummary - `createdAt` string - `description` string - `id` string - `name` string - `updatedAt` string - `defaultTemplateId` string - `description` string - `icon` string - `id` string - `isLocation` boolean - `name` string - `updatedAt` string - `id` string - `imageId` string, nullable - `insured` boolean - `itemCount` number — Container-specific (populated when querying locations) - `name` string - `parent` RepoEntitySummary — recursive - `purchasePrice` number - `quantity` number - `soldDate` string — Sale details - `tags` RepoTagSummary[] - `color` string - `createdAt` string - `description` string - `icon` string - `id` string - `name` string - `parentId` string, nullable - `updatedAt` string - `thumbnailId` string, nullable - `updatedAt` string - `manufacturer` string - `modelNumber` string - `name` string - `notes` string — Extras - `parent` RepoEntitySummary - `archived` boolean - `assetId` string - `createdAt` string - `description` string - `entityType` RepoEntityTypeSummary - `createdAt` string - `defaultTemplate` RepoEntityTemplateSummary - `createdAt` string - `description` string - `id` string - `name` string - `updatedAt` string - `defaultTemplateId` string - `description` string - `icon` string - `id` string - `isLocation` boolean - `name` string - `updatedAt` string - `id` string - `imageId` string, nullable - `insured` boolean - `itemCount` number — Container-specific (populated when querying locations) - `name` string - `parent` RepoEntitySummary — recursive - `purchasePrice` number - `quantity` number - `soldDate` string — Sale details - `tags` RepoTagSummary[] - `color` string - `createdAt` string - `description` string - `icon` string - `id` string - `name` string - `parentId` string, nullable - `updatedAt` string - `thumbnailId` string, nullable - `updatedAt` string - `purchaseDate` string — Purchase - `purchaseFrom` string - `purchasePrice` number - `quantity` number - `serialNumber` string - `soldDate` string — Sold - `soldNotes` string - `soldPrice` number - `soldTo` string - `syncChildEntityLocations` boolean - `tags` RepoTagSummary[] - `color` string - `createdAt` string - `description` string - `icon` string - `id` string - `name` string - `parentId` string, nullable - `updatedAt` string - `thumbnailId` string, nullable - `totalPrice` number - `updatedAt` string - `warrantyDetails` string - `warrantyExpires` string --- [API](https://skmtc.net/sysadminsmedia/apis/homebox-api.md) · [All operations](https://skmtc.net/sysadminsmedia/apis/homebox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sysadminsmedia/homebox-api/versions/f19934d1b3ab/schema)