Replace custom field values on many records

PUT /v1/custom-metadata/{entityType}

Replace custom field values on many records

The replace above across many records of one type in one call. Every item ends up holding exactly the document submitted for it. Same all-or-nothing rule and 200-item cap as the batch merge.

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

Path Parameters

entityType required

any

Request Body

BatchCustomMetadataValuesRequest

itemsrequired

object[]

The records to write, each with its own custom fields. Up to 200 per call; an id may appear once. Every record must exist, or the whole call is rejected and nothing is written.

customMetadatarequired

Record<string, any>

The custom fields to write. Values are strings, numbers or booleans; a `null` clears the field.

entityIdrequired

string

The id of the record, of the type named in the path.

Example Request

application/json

{
  "items": [
    {
      "entityId": "string",
      "customMetadata": {}
    }
  ]
}

Response Schema

BatchCustomMetadataValuesResponse

entityTyperequired

any

moderequired

any

Which rule the write followed.

updatedrequired

object[]

Every record written, in the order submitted, each with its custom fields as they stand after the write.

customMetadatarequired

Record<string, any>

entityIdrequired

string

Example Response

200 OK — application/json

{
  "updated": [
    {
      "entityId": "string",
      "customMetadata": {}
    }
  ]
}