Update a Source

Update a document ingestion source with PATCH /v1/sources/:id: rename it or change its default schema. Partial update — omitted fields stay unchanged.

The PATCH /v1/sources/:id endpoint updates an existing document ingestion source in place. Two properties are writable: name, the human-readable label shown in listings and the dashboard, and default_schema_id, the extraction schema stamped on documents ingested through this source. The update is partial: any field you omit keeps its current value, so you can rename a source without touching its schema assignment and vice versa.

Renaming is purely cosmetic — the source keeps its UUID, its endpoint URL, its scoped API key, and every document link, so no integration breaks when you rename. Changing default_schema_id affects future ingests only: documents already processed keep the extractions they have, and documents ingested after the update pick up the new default schema. Pass null to remove the default schema entirely, leaving new documents to schema-less ingestion.

The endpoint requires the write scope and answers with the full updated source object, in the same shape GET /v1/sources/:id returns: id, name, type, status, document_count, default_schema, endpoint, created_at, and links. There is no dedicated response envelope for the update — read the returned object as the new current state.

Only these two fields are updatable over the API. A source's type is fixed at creation, its API key cannot be rotated in place (create a new source for a fresh key), and connector configuration for dashboard-created sources (Google Drive folders, SharePoint sites, sync cadence) is managed in the Talonic dashboard, not through this endpoint.

curl -X PATCH https://api.talonic.com/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer $TALONIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Invoice Intake (EU)", "default_schema_id": "c3d4e5f6-a7b8-9012-cdef-123456789012" }'

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Invoice Intake (EU)",
  "type": "api",
  "status": "active",
  "document_count": 234,
  "default_schema": { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012" },
  "endpoint": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
  "created_at": "2024-08-01T09:00:00.000Z",
  "links": {
    "self": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "documents": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
    "dashboard": "https://app.talonic.com/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

curl -X PATCH https://api.talonic.com/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer $TALONIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "default_schema_id": null }'

Errors