PATCH `/v1/ai/recipes/{recipeId}`

Edit an AI posting recipe.

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin links.edit; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

Partial update. The schedule is recomputed on every write rather than by a nightly job — a recipe saved with a cadence and no next run is a recipe that never runs and shows no error anywhere. Requires `links.edit`.

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`recipeId (path)`	`Uuid`	Ya	—

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`name`	`string`	Ya	—
`is_enabled`	`boolean`	Tidak	—
`brief`	`string`	Tidak	—
`tone`	`string`	Tidak	—
`word_count`	`integer`	Tidak	—
`language`	`string`	Tidak	—
`posts_per_run`	`integer`	Tidak	—
`provider`	`string`	Tidak	—
`model_id`	`string`	Tidak	—
`model_family`	`string`	Tidak	—
`anchors`	`AiAnchor[]`	Tidak	—
`anchor_policy`	`string<none, every_post, rotate>`	Tidak	—
`link_set_id`	`string`	Tidak	The reusable link set this recipe draws its links from, or `null` to use the recipe's own `anchors`. When set it replaces `anchors` rather than adding to them — two sources…
`cadence`	`string<manual, daily, weekly, monthly>`	Tidak	—
`cadence_hour_utc`	`integer`	Tidak	—
`cadence_dow`	`integer`	Tidak	—
`cadence_dom`	`integer`	Tidak	—
`target_kind`	`string<none, sites, site_group, cms_targets>`	Tidak	—
`target_sites`	`string[]`	Tidak	—
`target_site_group_id`	`object`	Tidak	—
`target_cms_target_ids`	`string[]`	Tidak	—
`target_category`	`string`	Tidak	—
`requires_capabilities`	`string[]`	Tidak	—
`capability_policy`	`string<refuse, degrade, ask>`	Tidak	—
`image_provider`	`string`	Tidak	—
`image_model`	`string`	Tidak	—
`featured_image`	`boolean`	Tidak	—
`inline_image_count`	`integer`	Tidak	—
`inline_placement`	`string<after_intro, between_sections, end>`	Tidak	—
`image_style`	`string`	Tidak	—
`publish_mode`	`string<draft, schedule, publish>`	Tidak	—
`schedule_offset_hours`	`integer`	Tidak	—
`schedule_stagger_minutes`	`integer`	Tidak	—
`org_id`	`Uuid`	Tidak	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ya	—
`is_enabled`	`boolean`	Ya	—
`brief`	`string`	Tidak	—
`tone`	`string`	Tidak	—
`word_count`	`integer`	Tidak	—
`language`	`string`	Tidak	BCP-47, or empty for "the language the brief is written in".
`posts_per_run`	`integer`	Tidak	⛔ Capped at 10. Two hundred articles from one brief are two hundred near-identical articles, which is a footprint — the exact thing the Footprint-Free line is sold to avoid.
`provider`	`string`	Tidak	Blank = whatever the funding route resolves to.
`model_id`	`string`	Tidak	Blank = the newest verified model in the family.
`model_family`	`string`	Tidak	—
`anchors`	`AiAnchor[]`	Tidak	—
`anchor_policy`	`string<none, every_post, rotate>`	Tidak	—
`link_set_id`	`string`	Tidak	The reusable link set this recipe draws its links from, or `null` to use the recipe's own `anchors`. When set it replaces `anchors` rather than adding to them — two sources…
`cadence`	`string<manual, daily, weekly, monthly>`	Ya	—
`cadence_hour_utc`	`integer`	Tidak	—
`cadence_dow`	`integer`	Tidak	0 = Monday.
`cadence_dom`	`integer`	Tidak	⛔ Never 29-31: a monthly recipe set to the 31st would skip February silently, and a schedule that stops without an error is the failure this feature prevents.
`next_run_at`	`object`	Tidak	—
`last_run_at`	`object`	Tidak	—
`target_kind`	`string<none, sites, site_group, cms_targets>`	Tidak	—
`target_sites`	`string[]`	Tidak	—
`target_site_group_id`	`object`	Tidak	—
`target_cms_target_ids`	`string[]`	Tidak	—
`target_category`	`string`	Tidak	—
`requires_capabilities`	`string[]`	Tidak	Capability ids the target must support, e.g. `cms_target:featured_image`. Enforced on every run: each site's capabilities are read from its CMS target and any shortfall is handl…
`capability_policy`	`string<refuse, degrade, ask>`	Tidak	What to do when a target cannot do something the recipe requires. Default `refuse` — silently dropping a requested field is the failure this exists to stop. `refuse` skips that…
`image_provider`	`string`	Tidak	—
`image_model`	`string`	Tidak	—
`featured_image`	`boolean`	Tidak	—
`inline_image_count`	`integer`	Tidak	—
`inline_placement`	`string<after_intro, between_sections, end>`	Tidak	—
`image_style`	`string`	Tidak	—
`publish_mode`	`string<draft, schedule, publish>`	Ya	⚖️ Owner ruling 2026-08-20: a per-recipe switch defaulting to `draft`. `draft` writes into the library and schedules nothing; `schedule` queues placements the customer can s…
`schedule_offset_hours`	`integer`	Tidak	—
`schedule_stagger_minutes`	`integer`	Tidak	Minutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
`blocking_providers`	`string[]`	Tidak	Providers this recipe needs a working key for and does not have. Empty means it can run now. ⚖️ A recipe naming no provider is never blocked — credits are the default route and…
`created_at`	`string`	Ya	—
`updated_at`	`string`	Tidak	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429