Sources

Update a source

patch/v1/sources/{id}

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/sources/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Resource UUID.

Request body

namestring
default_schema_idstring uuid nullable

Set to null to remove the default schema.

Example request

{
  "default_schema_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response

Source updated.

idstring uuid required
namestring required
typestring required
status'active' | 'syncing' | 'error' required
document_countinteger
endpointstring

URL path for uploading documents to this source.

created_atstring date-time

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Invoices Ingest",
  "type": "api",
  "status": "completed",
  "document_count": 42,
  "default_schema": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "endpoint": "/v1/sources/abc-123/documents",
  "created_at": "2026-04-25T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.