PATCH
/
v3
/
collections
/
{identifier}
Update a collection
curl --request PATCH \
  --url https://{region}.affinda.com/v3/collections/{identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "autoValidationThreshold": 123,
  "enableAutoValidationThreshold": false,
  "fields": [
    {
      "label": "<string>",
      "fields": [
        {
          "label": "<string>",
          "slug": "<string>",
          "fieldType": "text",
          "dataSource": "<string>",
          "mapping": "<string>",
          "dataPoint": "<string>",
          "mandatory": true,
          "disabled": true,
          "autoValidationThreshold": 123,
          "showDropdown": true,
          "displayRawText": true,
          "dropNull": true,
          "displayEnumValue": true,
          "fields": [
            {}
          ]
        }
      ]
    }
  ],
  "fieldsLayout": {
    "defaultCategory": {
      "label": "<string>",
      "enabledFields": [
        {
          "label": "<string>",
          "dataPoint": "<string>",
          "fieldType": "text",
          "dataSource": "<string>",
          "mapping": "<string>",
          "mandatory": true,
          "autoValidationThreshold": 0.5,
          "enableAutoValidationThreshold": true,
          "showDropdown": true,
          "displayEnumValue": true,
          "hideEnumDetail": true,
          "dropNull": true,
          "enabledChildFields": [
            {}
          ],
          "disabledChildFields": [
            {}
          ],
          "slug": "<string>",
          "displayRawText": true,
          "fields": [
            {}
          ]
        }
      ],
      "disabledFields": [
        {
          "label": "<string>",
          "dataPoint": "<string>",
          "fieldType": "text",
          "dataSource": "<string>",
          "mapping": "<string>",
          "mandatory": true,
          "autoValidationThreshold": 0.5,
          "enableAutoValidationThreshold": true,
          "showDropdown": true,
          "displayEnumValue": true,
          "hideEnumDetail": true,
          "dropNull": true,
          "enabledChildFields": [
            {}
          ],
          "disabledChildFields": [
            {}
          ],
          "slug": "<string>",
          "displayRawText": true,
          "fields": [
            {}
          ]
        }
      ]
    },
    "categories": [
      {
        "label": "<string>",
        "enabledFields": [
          {
            "label": "<string>",
            "dataPoint": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "mandatory": true,
            "autoValidationThreshold": 0.5,
            "enableAutoValidationThreshold": true,
            "showDropdown": true,
            "displayEnumValue": true,
            "hideEnumDetail": true,
            "dropNull": true,
            "enabledChildFields": [
              {}
            ],
            "disabledChildFields": [
              {}
            ],
            "slug": "<string>",
            "displayRawText": true,
            "fields": [
              {}
            ]
          }
        ],
        "disabledFields": [
          {
            "label": "<string>",
            "dataPoint": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "mandatory": true,
            "autoValidationThreshold": 0.5,
            "enableAutoValidationThreshold": true,
            "showDropdown": true,
            "displayEnumValue": true,
            "hideEnumDetail": true,
            "dropNull": true,
            "enabledChildFields": [
              {}
            ],
            "disabledChildFields": [
              {}
            ],
            "slug": "<string>",
            "displayRawText": true,
            "fields": [
              {}
            ]
          }
        ]
      }
    ]
  },
  "dateFormatPreference": "DMY",
  "dateFormatFromDocument": true,
  "extractorConfig": {
    "resumeRedact": {
      "redactHeadshot": true,
      "redactPersonalDetails": true,
      "redactWorkDetails": true,
      "redactReferees": true,
      "redactEducationDetails": true,
      "redactLocations": true,
      "redactDates": true,
      "redactGender": true
    }
  },
  "allowOpenai": false,
  "trainsExtractor": true,
  "disableConfirmationIfValidationRulesFail": false
}'
{
  "identifier": "mEFayXdO",
  "name": "<string>",
  "workspace": {
    "identifier": "mEFayXdO",
    "organization": {
      "identifier": "mEFayXdO",
      "name": "Grove Street King",
      "userRole": "admin",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
      "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
      "isTrial": true,
      "validationToolConfig": {
        "theme": {
          "palette": {
            "mode": "light",
            "background": "<string>",
            "text": {
              "primary": "<any>",
              "secondary": "<any>",
              "disabled": "<any>"
            },
            "divider": "<string>",
            "primary": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "secondary": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "success": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "annotation": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "error": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "info": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "warning": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            }
          },
          "typography": {
            "fontFamily": "<string>",
            "fontSize": "<string>",
            "fontWeightRegular": "<string>",
            "fontWeightMedium": "<string>",
            "fontWeightBold": "<string>"
          },
          "borderRadius": 123,
          "fontUrl": "<string>"
        },
        "hideActions": true,
        "hideCollection": true,
        "hideEditPages": true,
        "hideExport": true,
        "hideFilename": true,
        "hideReject": true,
        "hideReparse": true,
        "hideRunOcr": true,
        "hideTags": true,
        "hideWarnings": true,
        "restrictDocumentSplitting": true,
        "disableCurrencyFormatting": true,
        "disableEditDocumentMetadata": true
      },
      "showCustomFieldCreation": true
    },
    "name": "<string>"
  },
  "extractor": {
    "identifier": "resume",
    "name": "<string>",
    "namePlural": "<string>",
    "baseExtractor": {
      "identifier": "resume",
      "name": "<string>",
      "namePlural": "<string>",
      "validatable": true,
      "isCustom": true,
      "createdDt": "2023-11-07T05:31:56Z"
    },
    "organization": {
      "identifier": "mEFayXdO",
      "name": "Grove Street King",
      "userRole": "admin",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
      "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
      "isTrial": true,
      "validationToolConfig": {
        "theme": {
          "palette": {
            "mode": "light",
            "background": "<string>",
            "text": {
              "primary": "<any>",
              "secondary": "<any>",
              "disabled": "<any>"
            },
            "divider": "<string>",
            "primary": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "secondary": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "success": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "annotation": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "error": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "info": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "warning": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            }
          },
          "typography": {
            "fontFamily": "<string>",
            "fontSize": "<string>",
            "fontWeightRegular": "<string>",
            "fontWeightMedium": "<string>",
            "fontWeightBold": "<string>"
          },
          "borderRadius": 123,
          "fontUrl": "<string>"
        },
        "hideActions": true,
        "hideCollection": true,
        "hideEditPages": true,
        "hideExport": true,
        "hideFilename": true,
        "hideReject": true,
        "hideReparse": true,
        "hideRunOcr": true,
        "hideTags": true,
        "hideWarnings": true,
        "restrictDocumentSplitting": true,
        "disableCurrencyFormatting": true,
        "disableEditDocumentMetadata": true
      },
      "showCustomFieldCreation": true
    },
    "category": "Recruitment",
    "validatable": true,
    "isCustom": true,
    "fieldGroups": [
      {
        "label": "<string>",
        "fields": [
          {
            "label": "<string>",
            "slug": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "dataPoint": "<string>",
            "mandatory": true,
            "disabled": true,
            "autoValidationThreshold": 123,
            "showDropdown": true,
            "displayRawText": true,
            "dropNull": true,
            "displayEnumValue": true,
            "fields": [
              {}
            ]
          }
        ]
      }
    ],
    "createdDt": "2023-11-07T05:31:56Z",
    "lastTrainedDt": "2023-11-07T05:31:56Z"
  },
  "autoValidationThreshold": 123,
  "enableAutoValidationThreshold": false,
  "autoValidateIfValidationRulesPass": false,
  "fields": [
    {
      "label": "<string>",
      "fields": [
        {
          "label": "<string>",
          "slug": "<string>",
          "fieldType": "text",
          "dataSource": "<string>",
          "mapping": "<string>",
          "dataPoint": "<string>",
          "mandatory": true,
          "disabled": true,
          "autoValidationThreshold": 123,
          "showDropdown": true,
          "displayRawText": true,
          "dropNull": true,
          "displayEnumValue": true,
          "fields": [
            {}
          ]
        }
      ]
    }
  ],
  "fieldsLayout": {
    "defaultCategory": {
      "label": "<string>",
      "enabledFields": [
        {
          "label": "<string>",
          "dataPoint": "<string>",
          "fieldType": "text",
          "dataSource": "<string>",
          "mapping": "<string>",
          "mandatory": true,
          "autoValidationThreshold": 0.5,
          "enableAutoValidationThreshold": true,
          "showDropdown": true,
          "displayEnumValue": true,
          "hideEnumDetail": true,
          "dropNull": true,
          "enabledChildFields": [
            {}
          ],
          "disabledChildFields": [
            {}
          ],
          "slug": "<string>",
          "displayRawText": true,
          "fields": [
            {}
          ]
        }
      ],
      "disabledFields": [
        {
          "label": "<string>",
          "dataPoint": "<string>",
          "fieldType": "text",
          "dataSource": "<string>",
          "mapping": "<string>",
          "mandatory": true,
          "autoValidationThreshold": 0.5,
          "enableAutoValidationThreshold": true,
          "showDropdown": true,
          "displayEnumValue": true,
          "hideEnumDetail": true,
          "dropNull": true,
          "enabledChildFields": [
            {}
          ],
          "disabledChildFields": [
            {}
          ],
          "slug": "<string>",
          "displayRawText": true,
          "fields": [
            {}
          ]
        }
      ]
    },
    "categories": [
      {
        "label": "<string>",
        "enabledFields": [
          {
            "label": "<string>",
            "dataPoint": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "mandatory": true,
            "autoValidationThreshold": 0.5,
            "enableAutoValidationThreshold": true,
            "showDropdown": true,
            "displayEnumValue": true,
            "hideEnumDetail": true,
            "dropNull": true,
            "enabledChildFields": [
              {}
            ],
            "disabledChildFields": [
              {}
            ],
            "slug": "<string>",
            "displayRawText": true,
            "fields": [
              {}
            ]
          }
        ],
        "disabledFields": [
          {
            "label": "<string>",
            "dataPoint": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "mandatory": true,
            "autoValidationThreshold": 0.5,
            "enableAutoValidationThreshold": true,
            "showDropdown": true,
            "displayEnumValue": true,
            "hideEnumDetail": true,
            "dropNull": true,
            "enabledChildFields": [
              {}
            ],
            "disabledChildFields": [
              {}
            ],
            "slug": "<string>",
            "displayRawText": true,
            "fields": [
              {}
            ]
          }
        ]
      }
    ]
  },
  "fieldsConfigured": true,
  "dateFormatPreference": "DMY",
  "dateFormatFromDocument": true,
  "extractorConfig": {
    "resumeRedact": {
      "redactHeadshot": true,
      "redactPersonalDetails": true,
      "redactWorkDetails": true,
      "redactReferees": true,
      "redactEducationDetails": true,
      "redactLocations": true,
      "redactDates": true,
      "redactGender": true
    }
  },
  "unvalidatedDocsCount": 1,
  "confirmedDocsCount": 1,
  "ingestEmail": "<string>",
  "tailoredExtractorRequested": true,
  "allowOpenai": false,
  "trainsExtractor": true,
  "disableConfirmationIfValidationRulesFail": false,
  "autoRefreshValidationResults": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

​
identifier
string
required

Collection's identifier

Example:

"mEFayXdO"

Body

application/json

Collection data to update

​
name
string
​
autoValidationThreshold
number
​
enableAutoValidationThreshold
boolean
default:false
​
fields
object[] | null
deprecated
​
fieldsLayout
object
​
dateFormatPreference
enum<string> | null
Available options:
DMY,
MDY,
YMD
​
dateFormatFromDocument
boolean | null

Predict the date format from any dates in the document that is not ambiguous.

​
extractorConfig
object | null

Extra configurations specific to an extractor.

​
allowOpenai
boolean
default:false

Whether to allow OpenAI API to be used to assist in creating a model for this collection.

​
trainsExtractor
boolean

Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors.

​
disableConfirmationIfValidationRulesFail
boolean
default:false

If True, users cannot validate documents with missing mandatory fields, or failing validation rules.

Response

Successfully updated collection data.

​
identifier
string
required

Uniquely identify a collection.

Example:

"mEFayXdO"

​
name
string
​
workspace
object
​
extractor
object
​
autoValidationThreshold
number
​
enableAutoValidationThreshold
boolean
default:false
​
autoValidateIfValidationRulesPass
boolean
default:false
​
fields
object[] | null
deprecated
​
fieldsLayout
object
​
fieldsConfigured
boolean
​
dateFormatPreference
enum<string> | null
Available options:
DMY,
MDY,
YMD
​
dateFormatFromDocument
boolean | null

Predict the date format from any dates in the document that is not ambiguous.

​
extractorConfig
object | null

Extra configurations specific to an extractor.

​
unvalidatedDocsCount
integer | null

Number of unvalidated documents in the collection.

Required range: x >= 0
​
confirmedDocsCount
integer | null

Number of validated documents in the collection.

Required range: x >= 0
​
ingestEmail
string

When you send email to this address, any document attached in the body will be uploaded to this collection.

​
tailoredExtractorRequested
boolean

Whether a tailored extractor has been requested for this collection.

​
allowOpenai
boolean
default:false

Whether to allow OpenAI API to be used to assist in creating a model for this collection.

​
trainsExtractor
boolean

Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors.

​
disableConfirmationIfValidationRulesFail
boolean
default:false

If True, users cannot validate documents with missing mandatory fields, or failing validation rules.

​
autoRefreshValidationResults
boolean
default:true

If True, validation results are refreshed whenever annotations are changed.