Skip to main content
Version: 1.0.0

Update multiple documents

info
  • client write secret is required for adding, modifying, or deleting data.

Overview​

Path
PUT / PATCH/v1/collections/{collectionName}/documents

  • Update multiple documents at once.
  • PUT method
    • PUT method performs an upsert operation.
    • When updating a Document in the Collection, it performs a destructive update, clearing all unspecified cell values.
  • PATCH method
    • PATCH method cannot update non-existent Documents.
    • Updates only the specified fields, leaving the rest unchanged.

Example​

curl -X PUT https://api.invector.co/v1/collections/{collectionName}/documents \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \
     -d '{
       "documents": [
         {
           "_id": "unique_document_id_123",
           "title": "Description of Philip",
           "name": "Philip",
           "age": 22,
           "department": "Engineering",
           "role": "Software Engineer",
           "email": "philipchoi@togglecampus.com"
         }
       ]
     }'
curl -X PATCH https://api.invector.co/v1/collections/{collectionName}/documents \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \
     -d '{
       "documents": [
         {
           "_id": "unique_document_id_123",
           "name": "Philips",
           "age": 23,
           "email": "philip@togglecampus.com"
         }
       ]
     }'

Authorization​

Authorization
BasicBasic authorization at Header. Base64 encoding required
client_id
string
client_secret
string
example

 curl -X PUT https://api.invector.co/v1/collections/{collectionName}/documents \
      -H "Content-Type: application/json" \
      -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \
     ...

Path Parameters​

collectionName
string

Request Body​

documents
array of objectArray of documents to be created.
_id
stringUnique Document ID.
title
string (required if PUT)Title of the document.
[other fields …]
anyOther fields of the document.
example
{
  "documents": [
    {
      "_id": "unique_document_id_123",
      "title": "Description of Philip",
      "name": "Philip",
      "age": 22,
      "department": "Engineering",
      "role": "Software Engineer",
      "email": "philipchoi@togglecampus.com"
    }
  ]
}

Response Body​

documents
array of objectArray of documents updated.
_id
stringUnique Document ID.
title
stringTitle of the document.
[other fields …]
anyOther fields of the document.
example
{
  "documents": [
    {
      "_id": "unique_document_id_123",
      "title": "Description of Philip",
      "name": "Philip",
      "age": 22,
      "department": "Engineering",
      "role": "Software Engineer",
      "email": "philipchoi@togglecampus.com"
    }
  ]
}