Fields

Patch Field

Changed on

Partially update a field using PATCH (merge-patch semantics). Only provided fields will be updated; omitted fields remain unchanged. Unlike create/PUT, PATCH does not require the type-specific options object to be (re-)supplied; an already-valid persisted options object is left as-is when omitted from the request.

patch/v2/fields/{id}

Request

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

Path parameters

idstring required

ID of the field to be patched

Request body

idstring

Unique identifier of the field

createdAtstring

Date/time when this entity was created

updatedAtstring

Date/time when this entity was last updated

aliasstring

Unique alias identifier for the field

displayNamestring

Display name of the field. Maximum 256 characters; must be unique within the parent record type.

type'text' | 'long-text' | 'number' | 'percentage' | 'currency' | 'date' | 'single-select' | 'multi-select' | 'boolean' | 'reference' | 'user' | 'formula' | 'created-by' | 'created-at' | 'updated-by' | 'updated-at' | 'approved-by' | 'approved-at' | 'record-id'

Type of the field. Subject to per-record-type quotas: max 20 long-text, max 20 formula, max 30 reference. lookup and document are not directly creatable.

descriptionstring

Description of the field. Maximum 512 characters.

defaultOptionsstring[]

Default options for single-select and multi-select fields

defaultUsersstring[]

Default user option

hasErrorboolean

Indicates if the field has an error

isHtmlNativeboolean

Indicates if the long text field is HTML native

restrictedboolean

Indicates whether the field is currently restricted to selected users only (field-sharing wildcard set to "selected users"). Read-only.

Example request

{
  "id": "F693ab1c96f11ea3f4175e716",
  "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",
  "alias": "campaign_name",
  "displayName": "Campaign Name",
  "type": "text",
  "description": "Name of the marketing campaign"
}

Response

OK

idstring

Unique identifier of the field

createdAtstring

Date/time when this entity was created

updatedAtstring

Date/time when this entity was last updated

aliasstring

Unique alias identifier for the field

displayNamestring

Display name of the field. Maximum 256 characters; must be unique within the parent record type.

type'text' | 'long-text' | 'number' | 'percentage' | 'currency' | 'date' | 'single-select' | 'multi-select' | 'boolean' | 'reference' | 'user' | 'formula' | 'created-by' | 'created-at' | 'updated-by' | 'updated-at' | 'approved-by' | 'approved-at' | 'record-id'

Type of the field. Subject to per-record-type quotas: max 20 long-text, max 20 formula, max 30 reference. lookup and document are not directly creatable.

descriptionstring

Description of the field. Maximum 512 characters.

defaultOptionsstring[]

Default options for single-select and multi-select fields

defaultUsersstring[]

Default user option

hasErrorboolean

Indicates if the field has an error

isHtmlNativeboolean

Indicates if the long text field is HTML native

restrictedboolean

Indicates whether the field is currently restricted to selected users only (field-sharing wildcard set to "selected users"). Read-only.

Example response

{
  "id": "F693ab1c96f11ea3f4175e716",
  "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",
  "alias": "campaign_name",
  "displayName": "Campaign Name",
  "type": "text",
  "description": "Name of the marketing campaign"
}

Changes

  • v223b84acdafe2Revision changes
    • breaking

      removed the enum value CHECKBOX of the request property

    • breaking

      removed the enum value CURRENCY of the request property

    • breaking

      removed the enum value DATE of the request property

    • breaking

      removed the enum value FORMULA of the request property

    • breaking

      removed the enum value MULTI_SELECT of the request property

    • breaking

      removed the enum value NUMBER of the request property

    • breaking

      removed the enum value PARAGRAPH of the request property

    • breaking

      removed the enum value PERCENTAGE of the request property

    • breaking

      removed the enum value REFERENCE of the request property

    • breaking

      removed the enum value SINGLE_SELECT of the request property

    • breaking

      removed the enum value TEXT of the request property

    • breaking

      removed the enum value USER of the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      added the new ANG enum value to the // response property for the response status

    • warning

      added the new ANG enum value to the / response property for the response status

    • warning

      added the new AOA enum value to the // response property for the response status

    • warning

      added the new AOA enum value to the / response property for the response status

    • warning

      added the new AWG enum value to the // response property for the response status

    • warning

      added the new AWG enum value to the / response property for the response status

    • warning

      added the new BGN enum value to the // response property for the response status

    • warning

      added the new BGN enum value to the / response property for the response status

    • warning

      added the new BMD enum value to the // response property for the response status

    • warning

      added the new BMD enum value to the / response property for the response status

    • warning

      added the new BYR enum value to the // response property for the response status

    • warning

      added the new BYR enum value to the / response property for the response status

    • warning

      added the new CUC enum value to the // response property for the response status

    • warning

      added the new CUC enum value to the / response property for the response status

    • warning

      added the new CZK enum value to the // response property for the response status

    • warning

      added the new CZK enum value to the / response property for the response status

    • warning

      added the new FKP enum value to the // response property for the response status

    • warning

      added the new FKP enum value to the / response property for the response status

    • warning

      added the new GHS enum value to the // response property for the response status

    • warning

      added the new GHS enum value to the / response property for the response status

    • warning

      added the new GIP enum value to the // response property for the response status

    • warning

      added the new GIP enum value to the / response property for the response status

    • warning

      added the new HKD enum value to the // response property for the response status

    • warning

      added the new HKD enum value to the / response property for the response status

    • warning

      added the new KYD enum value to the // response property for the response status

    • warning

      added the new KYD enum value to the / response property for the response status

    • warning

      added the new LTL enum value to the // response property for the response status

    • warning

      added the new LTL enum value to the / response property for the response status

    • warning

      added the new LVL enum value to the // response property for the response status

    • warning

      added the new LVL enum value to the / response property for the response status

    • warning

      added the new MOP enum value to the // response property for the response status

    • warning

      added the new MOP enum value to the / response property for the response status

    • warning

      added the new MRO enum value to the // response property for the response status

    • warning

      added the new MRO enum value to the / response property for the response status

    • warning

      added the new MZN enum value to the // response property for the response status

    • warning

      added the new MZN enum value to the / response property for the response status

    • warning

      added the new SHP enum value to the // response property for the response status

    • warning

      added the new SHP enum value to the / response property for the response status

    • warning

      added the new SLE enum value to the // response property for the response status

    • warning

      added the new SLE enum value to the / response property for the response status

    • warning

      added the new STD enum value to the // response property for the response status

    • warning

      added the new STD enum value to the / response property for the response status

    • warning

      added the new SVC enum value to the // response property for the response status

    • warning

      added the new SVC enum value to the / response property for the response status

    • warning

      added the new TWD enum value to the // response property for the response status

    • warning

      added the new TWD enum value to the / response property for the response status

    • warning

      added the new UGX enum value to the // response property for the response status

    • warning

      added the new UGX enum value to the / response property for the response status

    • warning

      added the new VES enum value to the // response property for the response status

    • warning

      added the new VES enum value to the / response property for the response status

    • warning

      added the new XCG enum value to the // response property for the response status

    • warning

      added the new XCG enum value to the / response property for the response status

    • warning

      added the new XDR enum value to the // response property for the response status

    • warning

      added the new XDR enum value to the / response property for the response status

    • warning

      added the new XPF enum value to the // response property for the response status

    • warning

      added the new XPF enum value to the / response property for the response status

    • warning

      added the new ZMW enum value to the // response property for the response status

    • warning

      added the new ZMW enum value to the / response property for the response status

    • warning

      added the new ZWG enum value to the // response property for the response status

    • warning

      added the new ZWG enum value to the / response property for the response status

    • warning

      added the new ZWL enum value to the // response property for the response status

    • warning

      added the new ZWL enum value to the / response property for the response status

    • warning

      added the new approved-at enum value to the response property for the response status

    • warning

      added the new approved-by enum value to the response property for the response status

    • warning

      added the new boolean enum value to the response property for the response status

    • warning

      added the new created-at enum value to the response property for the response status

    • warning

      added the new created-by enum value to the response property for the response status

    • warning

      added the new currency enum value to the response property for the response status

    • warning

      added the new date enum value to the response property for the response status

    • warning

      added the new formula enum value to the response property for the response status

    • warning

      added the new long-text enum value to the response property for the response status

    • warning

      added the new multi-select enum value to the response property for the response status

    • warning

      added the new number enum value to the response property for the response status

    • warning

      added the new percentage enum value to the response property for the response status

    • warning

      added the new record-id enum value to the response property for the response status

    • warning

      added the new reference enum value to the response property for the response status

    • warning

      added the new single-select enum value to the response property for the response status

    • warning

      added the new text enum value to the response property for the response status

    • warning

      added the new updated-at enum value to the response property for the response status

    • warning

      added the new updated-by enum value to the response property for the response status

    • warning

      added the new user enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new ANG enum value to the request property //

    • info

      added the new ANG enum value to the request property /

    • info

      added the new AOA enum value to the request property //

    • info

      added the new AOA enum value to the request property /

    • info

      added the new AWG enum value to the request property //

    • info

      added the new AWG enum value to the request property /

    • info

      added the new BGN enum value to the request property //

    • info

      added the new BGN enum value to the request property /

    • info

      added the new BMD enum value to the request property //

    • info

      added the new BMD enum value to the request property /

    • info

      added the new BYR enum value to the request property //

    • info

      added the new BYR enum value to the request property /

    • info

      added the new CUC enum value to the request property //

    • info

      added the new CUC enum value to the request property /

    • info

      added the new CZK enum value to the request property //

    • info

      added the new CZK enum value to the request property /

    • info

      added the new FKP enum value to the request property //

    • info

      added the new FKP enum value to the request property /

    • info

      added the new GHS enum value to the request property //

    • info

      added the new GHS enum value to the request property /

    • info

      added the new GIP enum value to the request property //

    • info

      added the new GIP enum value to the request property /

    • info

      added the new HKD enum value to the request property //

    • info

      added the new HKD enum value to the request property /

    • info

      added the new KYD enum value to the request property //

    • info

      added the new KYD enum value to the request property /

    • info

      added the new LTL enum value to the request property //

    • info

      added the new LTL enum value to the request property /

    • info

      added the new LVL enum value to the request property //

    • info

      added the new LVL enum value to the request property /

    • info

      added the new MOP enum value to the request property //

    • info

      added the new MOP enum value to the request property /

    • info

      added the new MRO enum value to the request property //

    • info

      added the new MRO enum value to the request property /

    • info

      added the new MZN enum value to the request property //

    • info

      added the new MZN enum value to the request property /

    • info

      added the new SHP enum value to the request property //

    • info

      added the new SHP enum value to the request property /

    • info

      added the new SLE enum value to the request property //

    • info

      added the new SLE enum value to the request property /

    • info

      added the new STD enum value to the request property //

    • info

      added the new STD enum value to the request property /

    • info

      added the new SVC enum value to the request property //

    • info

      added the new SVC enum value to the request property /

    • info

      added the new TWD enum value to the request property //

    • info

      added the new TWD enum value to the request property /

    • info

      added the new UGX enum value to the request property //

    • info

      added the new UGX enum value to the request property /

    • info

      added the new VES enum value to the request property //

    • info

      added the new VES enum value to the request property /

    • info

      added the new XCG enum value to the request property //

    • info

      added the new XCG enum value to the request property /

    • info

      added the new XDR enum value to the request property //

    • info

      added the new XDR enum value to the request property /

    • info

      added the new XPF enum value to the request property //

    • info

      added the new XPF enum value to the request property /

    • info

      added the new ZMW enum value to the request property //

    • info

      added the new ZMW enum value to the request property /

    • info

      added the new ZWG enum value to the request property //

    • info

      added the new ZWG enum value to the request property /

    • info

      added the new ZWL enum value to the request property //

    • info

      added the new ZWL enum value to the request property /

    • info

      added the new approved-at enum value to the request property

    • info

      added the new approved-by enum value to the request property

    • info

      added the new boolean enum value to the request property

    • info

      added the new created-at enum value to the request property

    • info

      added the new created-by enum value to the request property

    • info

      added the new currency enum value to the request property

    • info

      added the new date enum value to the request property

    • info

      added the new formula enum value to the request property

    • info

      added the new long-text enum value to the request property

    • info

      added the new multi-select enum value to the request property

    • info

      added the new number enum value to the request property

    • info

      added the new percentage enum value to the request property

    • info

      added the new record-id enum value to the request property

    • info

      added the new reference enum value to the request property

    • info

      added the new single-select enum value to the request property

    • info

      added the new text enum value to the request property

    • info

      added the new updated-at enum value to the request property

    • info

      added the new updated-by enum value to the request property

    • info

      added the new user enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the CHECKBOX enum value from the response property for the response status

    • info

      removed the CURRENCY enum value from the response property for the response status

    • info

      removed the DATE enum value from the response property for the response status

    • info

      removed the FORMULA enum value from the response property for the response status

    • info

      removed the MULTI_SELECT enum value from the response property for the response status

    • info

      removed the NUMBER enum value from the response property for the response status

    • info

      removed the PARAGRAPH enum value from the response property for the response status

    • info

      removed the PERCENTAGE enum value from the response property for the response status

    • info

      removed the REFERENCE enum value from the response property for the response status

    • info

      removed the SINGLE_SELECT enum value from the response property for the response status

    • info

      removed the TEXT enum value from the response property for the response status

    • info

      removed the USER enum value from the response property for the response status

  • v2986ecd481ee6Revision changes
    • warning

      added the new long enum value to the / response property for the response status

    • warning

      added the new long enum value to the // response property for the response status

    • warning

      added the new medium enum value to the / response property for the response status

    • warning

      added the new medium enum value to the // response property for the response status

    • warning

      added the new short enum value to the / response property for the response status

    • warning

      added the new short enum value to the // response property for the response status

    • info

      added the new long enum value to the request property /

    • info

      added the new long enum value to the request property //

    • info

      added the new medium enum value to the request property /

    • info

      added the new medium enum value to the request property //

    • info

      added the new short enum value to the request property /

    • info

      added the new short enum value to the request property //