UPDATE CUSTOM FIELDS

Updates custom fields for any supported module record.

Supported Modules

Note: Plural forms (PRODUCTS, ESTIMATES, ASSETS, PURCHASE_ORDERS, SERVICE_CONTRACTS) are also accepted and normalized automatically.

Update Behavior (Partial Update)

This API uses a MERGE strategy, NOT a full replacement.

• ONLY send fields that are NEW or CHANGED
• Existing fields NOT included in the request are PRESERVED
• No data loss occurs if you omit unchanged fields
• Fields are matched by: label + group_uid combination

Example

If a record has fields A, B, C and you send only field B with a new value, fields A and C remain unchanged.

Important Notes

1. This API does NOT support deletion of custom fields
2. To clear a field's value, send it with value: ""
3. At least one custom field must be included in the request
4. group_uid values are validated against existing custom field groups

Request Payload

{
  "module_name": "JOB",
  "module_uid": "uuid-string",
  "custom_fields": [
    {
      "label": "Field Name",
      "value": "Field Value",
      "group_uid": "uuid-or-null",
      "hide_to_fe": false,
      "hide_field": false,
      "read_only": false
    }
  ]
}

Field Descriptions

Custom Field Object

Response

Success returns the module UID and a summary message indicating how many fields were added/updated.

Behavior Summary