Printago API
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
any
entityId required
string

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
any
moderequired
any
Which rule the write followed.

Example Response

200 OK — application/json 
{
  "entityId": "string",
  "customMetadata": {}
}