Skip to content

Replace the custom fields

PUT /document-intelligence/v1/collections/{collection_id}/fields

Replace a collection's custom fields with exactly the set in the body: fields you omit are removed, the rest are updated or created. Built-in fields (like document_type and summary) are never touched.

Parameters

Name In Required Notes
collection_id path yes -

Request body

Field Type Required Notes
fields array of FieldIn yes -

Example

curl -X PUT "https://api.futuresmart.ai/document-intelligence/v1/collections/{collection_id}/fields" \
  -H "Authorization: Bearer $FS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": [
      {
        "name": "<name>"
      }
    ]
  }'

Responses

200

Field Type Required Notes
fields array of FieldOut yes -

Every failure, a malformed request included, comes back in the shared envelope with a stable code to branch on. See Errors.