PATCH
/
api
/
v1
/
documents
/
external
/
{external_id}
/
metadata
Update Document By External Id
curl --request PATCH \
  --url https://api.fieldwise.ai/api/v1/documents/external/{external_id}/metadata \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "metadata": {
    "author": "John Doe",
    "category": "research",
    "tags": [
      "machine-learning",
      "embeddings"
    ]
  }
}'
{
  "success": true,
  "data": {
    "status": true,
    "data": {
      "id": 123,
      "external_id": "<string>",
      "file_path": "<string>",
      "file_url": "<string>",
      "document_metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string | null

Path Parameters

external_id
string
required

Body

application/json

Request model for updating documents.

Response

200
application/json

Successful Response

The response is of type object.