Update Documents

POST /v2/organizations/documents/update

Update Documents

cURL

curl --request POST \
  --url https://api.velt.dev/v2/organizations/documents/update \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "documents": [
      {}
    ]
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Document(s) updated successfully.",
    "data": {
      "yourDocumentId": {
        "success": true,
        "id": "8121657101517513",
        "message": "Updated Successfully"
      }
    }
  }
}

Use this API to update metadata of documents within an organization.

Endpoint

POST https://api.velt.dev/v2/organizations/documents/update

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

Organization ID

documents · Document[] · required

Array of Document objects

Example Requests

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documents": [
      {
        "documentId": "yourDocumentId",
        "documentName": "Your Document Name"
      }
    ]
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Document(s) updated successfully.",
    "data": {
      "yourDocumentId": {
        "success": true,
        "id": "8121657101517513",
        "message": "Updated Successfully"
      }
    }
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Partial Failures

When only some of the documents in the batch fail, this endpoint returns HTTP 500 and puts a per-item breakdown in error.details, keyed by the document IDs you sent.

A partial failure is reported as 500 INTERNAL even when nothing actually went wrong on the server, such as when a document simply does not exist. Branch on the per-item code rather than the HTTP status when deciding whether to retry. Retrying on the status alone will loop on not-found, which will never succeed.

code · string

Why this particular item failed. Present on every entry with "success": false.

Value	Meaning	Safe to retry?
not-found	The document does not exist.	No
internal	A genuine server-side failure.	Yes

{
  "error": {
    "status": "INTERNAL",
    "message": "Error updating document(s).",
    "details": {
      "yourDocumentId1": {
        "success": true,
        "id": "8121657101517513",
        "message": "Updated Successfully"
      },
      "yourDocumentId2": {
        "success": false,
        "id": "yourDocumentId2",
        "message": "Document does not exist",
        "code": "not-found"
      }
    }
  }
}

{
  "result": {
    "status": "success",
    "message": "Document(s) updated successfully.",
    "data": {
      "yourDocumentId": {
        "success": true,
        "id": "8121657101517513",
        "message": "Updated Successfully"
      }
    }
  }
}