Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
batch_update
Update File Category Fields
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/batch_update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "fields": [
    {
      "field_id": "1234567890",
      "name": "<string>",
      "description": "<string>",
      "prompt": "<string>",
      "use_prompt": true,
      "alias": [
        "Invoice No.",
        "Bill Number"
      ],
      "identity": "invoice_number",
      "multi_value": true,
      "duplicate_value_distinct": true,
      "transform_settings": {
        "datetime_settings": {
          "format": "yyyy-MM-dd"
        },
        "enumerate_settings": {
          "items": [
            "VAT Special Invoice",
            "VAT General Invoice",
            "Electronic Invoice"
          ]
        },
        "regex_settings": {
          "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
          "replace": "$1/$2/$3"
        },
        "mismatch_action": {
          "default_value": "N/A"
        }
      },
      "extract_model": "Model 1"
    }
  ],
  "with_detail": true
}
'
{
  "code": 200,
  "msg": "<string>",
  "result": [
    {
      "field_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "prompt": "<string>",
      "use_prompt": true,
      "alias": [
        "<string>"
      ],
      "identity": "<string>",
      "multi_value": true,
      "duplicate_value_distinct": true,
      "transform_settings": {
        "datetime_settings": {
          "format": "yyyy-MM-dd"
        },
        "enumerate_settings": {
          "items": [
            "VAT Special Invoice",
            "VAT General Invoice",
            "Electronic Invoice"
          ]
        },
        "regex_settings": {
          "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
          "replace": "$1/$2/$3"
        },
        "mismatch_action": {
          "default_value": "N/A"
        }
      },
      "extract_model": "<string>",
      "enabled": 123
    }
  ]
}

Authorizations

x-ti-app-id
string
header
required
x-ti-secret-code
string
header
required

Body

application/json
workspace_id
string
required

Workspace ID

Example:

"1234567890"

category_id
string
required

File category ID

Example:

"1234567890"

fields
object[]
required

List of fields to update

Minimum array length: 1
with_detail
boolean

Whether to return full details for each updated field

Response

200 - application/json

Successfully updated fields

code
integer
required

Status code

Example:

200

msg
string
required

Status description

result
object[]

Updated field list when with_detail=true, otherwise null