Printago API
PATCH /v1/custom-metadata/{entityType}/{entityId}

Merge custom field values into a record

Merges the submitted fields into what the record already holds: keys not mentioned are left alone, and a key sent as `null` is removed. The record is locked for the merge, so two callers writing different keys at the same moment cannot lose each other's changes. Requires the same permission as editing the record itself — `part.edit` for a part, `printer.edit` for a printer, and so on.

Requires: printer.editpart.editsku.editorder.editmaterial.editmaterial.instance.editjob.edit.allbuild.editprofile.editmaintenance.edit

Path Parameters

entityType required
enum
The kind of entity the custom fields belong to
entityId required
string
The ID of the entity whose custom field values are set

Request Body

CustomMetadataValuesRequest
customMetadatarequired
Record<string, any>
The custom fields to write. Values are strings, numbers or booleans; a `null` clears the field.

Example Request

application/json 
{
  "customMetadata": {}
}

Response Schema

CustomMetadataValueResponse
customMetadatarequired
Record<string, any>
The record's custom fields as they stand after the write.
entityIdrequired
string
entityTyperequired
enum
orderskuprinterpartmaterialmaterialVariantprintJobpartBuildprofilematerialInstancemaintenanceItemcustomerorderItemfolder
moderequired
"replace" | "merge"
Which rule the write followed.
replacemerge

Example Response

200 OK — application/json 
{
  "entityType": "order",
  "entityId": "string",
  "mode": "replace",
  "customMetadata": {}
}