Discovery

Update Plan

patch/api/discovery-plans/{plan_id}

Request

  • Base URL: https://api.kolens.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.kolens.ai/api/discovery-plans/{plan_id}
  • Auth: HTTP bearer

Path parameters

plan_idstring required

Headers

x-kolens-user-idstring nullable

Request body

namestring nullable
keywordstring nullable
platformstring nullable
interval_hoursinteger nullable
max_videos_per_runinteger nullable
regionstring nullable

ISO-3166 alpha-2 country code. Send an empty string to clear the plan's region back to the global default.

target_list_idstring nullable
status'draft' | 'active' | 'disabled' nullable
data_sourcestring nullable

Response

Successful Response

idstring required
namestring required
keywordstring required
platformstring required
interval_hoursinteger required
max_videos_per_runinteger required
regionstring nullable
filtersobject nullable required
target_list_idstring nullable required
status'draft' | 'active' | 'disabled' required
effective_status'draft' | 'active' | 'disabled' | 'queued' | 'running' | 'failed' required
data_sourcestring required
last_run_atstring nullable required
next_run_atstring nullable required
last_job_idstring nullable required
last_job_statusstring nullable
last_errorstring nullable
created_atstring required
updated_atstring required

Changes

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