v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Fax AI

Update AI custom field definition

Update an existing custom field definition. Admin-only. (Permitted scopes: fax:all:edit, fax:ai_settings:edit)

patch/accounts/self/ai/custom-fields/{field_id}

Path parameters

field_idstring required

Custom field definition ID

Request body

namestring

Display name of the custom field

instructionsstring

AI extraction instructions for this field

enabledboolean

Whether this custom field is active

Response

Response containing a single custom field definition

idstring required

Unique identifier for the custom field

namestring required

Display name of the custom field

instructionsstring required

AI extraction instructions for this field

enabledboolean required

Whether this custom field is active

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Invoice Number",
  "instructions": "Extract the invoice or reference number from the document",
  "enabled": true
}