Deprecated End Points

Update a collection

Changed on Jun 14, 2026

Update data of a collection.

patch/v3/collections/{identifier}

Request

Base URL
https://api.affinda.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/affinda/apis/affinda-api-2/docs/v3/collections/:identifier/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

identifierstring required

Uniquely identify a collection.

Example:mEFayXdO

Collection's identifier

Request body

namestring

autoValidationThresholdnumber

enableAutoValidationThresholdboolean

dateFormatPreference'DMY' | 'MDY' | 'YMD' nullable

dateFormatFromDocumentboolean nullable

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

allowOpenaiboolean

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

trainsExtractorboolean

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

disableConfirmationIfValidationRulesFailboolean

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

Example request

{
  "extractorConfig": {
    "resumeRedact": {
      "redactHeadshot": true,
      "redactPersonalDetails": true,
      "redactWorkDetails": true,
      "redactReferees": true,
      "redactEducationDetails": true,
      "redactLocations": true,
      "redactDates": true,
      "redactGender": true
    }
  }
}

Response

Successfully updated collection data.

identifierstring required

Uniquely identify a collection.

namestring

autoValidationThresholdnumber

enableAutoValidationThresholdboolean

autoValidateIfValidationRulesPassboolean

fieldsConfiguredboolean

dateFormatPreference'DMY' | 'MDY' | 'YMD' nullable

dateFormatFromDocumentboolean nullable

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

unvalidatedDocsCountinteger nullable

Number of unvalidated documents in the collection.

confirmedDocsCountinteger nullable

Number of validated documents in the collection.

ingestEmailstring

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

tailoredExtractorRequestedboolean

Whether a tailored extractor has been requested for this collection.

allowOpenaiboolean

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

trainsExtractorboolean

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

disableConfirmationIfValidationRulesFailboolean

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

autoRefreshValidationResultsboolean

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

Example response

{
  "identifier": "mEFayXdO",
  "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"
    }
  },
  "extractor": {
    "identifier": "resume",
    "baseExtractor": {
      "identifier": "resume"
    },
    "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"
    },
    "category": "Recruitment"
  },
  "extractorConfig": {
    "resumeRedact": {
      "redactHeadshot": true,
      "redactPersonalDetails": true,
      "redactWorkDetails": true,
      "redactReferees": true,
      "redactEducationDetails": true,
      "redactLocations": true,
      "redactDates": true,
      "redactGender": true
    }
  }
}

Changes

Jun 14, 2026acca5642c0bc Revision changes
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
Nov 20, 2025978cf99a2ac0 Revision changes
- breaking
  the response property became nullable for the status
- info
  api tag Deprecated End Points added
- info
  api tag Document API - Collection removed
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status

Operation history (7 revisions)