UPDATE CUSTOM FIELDS

Updates custom fields for any supported module record.

PATCH /custom_fields

Supported Modules

Note: For PRODUCT, custom fields are stored under the product's meta_data field instead of custom_fields. Request payload is unchanged.

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

Note: Fields without a group_uid are all matched under a single implicit Default group. Two same-labelled fields in different groups are distinct records; two same-labelled fields with no group are the same record.

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
5. Labels not present in the company's custom field settings are still accepted and saved, but with group_uid, group_name and ref_uid forced to null.

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

{
  "type": "SUCCESS",
  "title": "Custom fields updated successfully",
  "message": "Updated 2 custom fields and added 1 custom fields",
  "data": {
    "job_uid": "uuid-string"
  }
}

The data key is module-specific: job_uid, customer_uid, property_uid, organization_uid, project_uid, request_uid, estimate_uid, invoice_uid, product_uid, purchase_order_uid, asset_uid, vendor_uid, and contract_uid for SERVICE_CONTRACT.

Errors

Side Effects

• An activity log entry is created when at least one field was added or changed.
• A <module>.update notification event is emitted.

Behavior Summary