Records

Patch Record

Changed on Sep 28, 2026

Partially update an existing record using PATCH (merge-patch semantics). Only provided fields will be updated; omitted fields remain unchanged. Setting a field value to JSON null (e.g. {"data":{"F123":null}}) explicitly clears that field; omitting the key leaves the field untouched. For list-type fields (connections, multi-select), you can use operational updates: [{"op": "add", "value": [...]}, {"op": "remove", "value": [...]}].

patch/v2/records/{id}

Request

Base URL: https://{customer-domain}/maestro/api
URL: https://{customer-domain}/maestro/api/v2/records/{id}
Auth: none declared

Path parameters

idstring required

ID of the record to be patched

Request body

idstring

Unique identifier of the record

createdAtstring

Date/time when this entity was created

updatedAtstring

Date/time when this entity was last updated

recordTypeIdstring

ID of the record type this record belongs to

dataobject

Field data for the record as key-value pairs where keys are field IDs

thumbnailUrlstring

URL of the record thumbnail image

Example request

{
  "id": "Rc69b2a78e63cd0d41a1bedf2e",
  "createdBy": {
    "id": "1C341E7B682505430A494138@0bd0200063c87f9749412b.e",
    "name": "Jane Doe"
  },
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedBy": {
    "id": "1C341E7B682505430A494138@0bd0200063c87f9749412b.e",
    "name": "Jane Doe"
  },
  "updatedAt": "2026-01-15T14:45:00.000Z",
  "recordTypeId": "Rt69b14f7e0e38f35f28c3ccee",
  "data": {
    "F693ab1c96f11ea3f4175e710": "Campaign Name",
    "F693ab1c96f11ea3f4175e711": "2026-03-15"
  },
  "thumbnailUrl": "/maestro/static/thumbnail/default/thumbnail-1.png",
  "coverImage": {
    "url": "/maestro/static/thumbnail/default/thumbnail-1.png"
  },
  "metadata": {
    "catalyzeId": "cat-12345"
  }
}

Response