Replace custom field values on a record

PUT /v1/custom-metadata/{entityType}/{entityId}

Replace custom field values on a record

Replaces the record's custom fields with exactly the submitted document. Anything the record held and the body omits is removed; `{}` clears them all.

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": {}
}