Sources

Update a source

Changed on

Changing url or recipe creates a new version (unchanged values create none). name, schedule and key_field change without a new version.

patch/v1/sources/{source_id}

Request

  • Base URL: https://sourcefinch.com
  • URL: https://sourcefinch.com/v1/sources/{source_id}
  • Auth: HTTP bearer

Path parameters

source_idstring uuid required

Headers

X-Request-Idstring

Echoed in the response and logs; generated when absent.

SourceFinch-Projectstring uuid

Project UUID. Required for session tokens; API keys are bound to their project.

Request body

namestring
urlstring uri
schedule'manual' | 'hourly' | 'daily' | 'weekly'
key_fieldstring nullable

Response

The updated source

idstring uuid required
project_idstring uuid required
namestring required
urlstring required
recipeobject required

A recipe@1 document (see the Recipe schema)

versioninteger required
recipe_version_idstring uuid nullable

The immutable reviewed recipe version, or null for a custom source

schedule'manual' | 'hourly' | 'daily' | 'weekly' required
key_fieldstring nullable required
next_run_atstring nullable required

ISO-8601 timestamp (UTC)

created_atstring required

ISO-8601 timestamp (UTC)

updated_atstring required

ISO-8601 timestamp (UTC)

Changes

  • 190cbe57a5e8Revision changes
    • info

      added the new optional request property ////

    • info

      added the new optional request property ////