Skip to main content
PATCH
/
accounts
/
self
/
ai
/
custom-fields
/
{field_id}
Update AI custom field definition
curl --request PATCH \
  --url https://restapi.fax.plus/v3/accounts/self/ai/custom-fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "enabled": true
}
'
{
  "id": "507f1f77bcf86cd799439011",
  "name": "Invoice Number",
  "instructions": "Extract the invoice or reference number from the document",
  "enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

field_id
string
required

Custom field definition ID

Body

application/json

Request to update an AI custom field definition. All fields are optional

name
string

Display name of the custom field

instructions
string

AI extraction instructions for this field

enabled
boolean

Whether this custom field is active

Response

Response containing a single custom field definition

AI custom field definition

id
string
required

Unique identifier for the custom field

name
string
required

Display name of the custom field

instructions
string
required

AI extraction instructions for this field

enabled
boolean
required

Whether this custom field is active