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

Edit an AI posting recipe.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation links.edit ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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`.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`recipeId (path)`	`Uuid`	Oui	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`name`	`string`	Oui	—
`is_enabled`	`boolean`	Non	—
`brief`	`string`	Non	—
`tone`	`string`	Non	—
`word_count`	`integer`	Non	—
`language`	`string`	Non	—
`posts_per_run`	`integer`	Non	—
`provider`	`string`	Non	—
`model_id`	`string`	Non	—
`model_family`	`string`	Non	—
`anchors`	`AiAnchor[]`	Non	—
`anchor_policy`	`string<none, every_post, rotate>`	Non	—
`link_set_id`	`string`	Non	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>`	Non	—
`cadence_hour_utc`	`integer`	Non	—
`cadence_dow`	`integer`	Non	—
`cadence_dom`	`integer`	Non	—
`target_kind`	`string<none, sites, site_group, cms_targets>`	Non	—
`target_sites`	`string[]`	Non	—
`target_site_group_id`	`object`	Non	—
`target_cms_target_ids`	`string[]`	Non	—
`target_category`	`string`	Non	—
`requires_capabilities`	`string[]`	Non	—
`capability_policy`	`string<refuse, degrade, ask>`	Non	—
`image_provider`	`string`	Non	—
`image_model`	`string`	Non	—
`featured_image`	`boolean`	Non	—
`inline_image_count`	`integer`	Non	—
`inline_placement`	`string<after_intro, between_sections, end>`	Non	—
`image_style`	`string`	Non	—
`publish_mode`	`string<draft, schedule, publish>`	Non	—
`schedule_offset_hours`	`integer`	Non	—
`schedule_stagger_minutes`	`integer`	Non	—
`org_id`	`Uuid`	Non	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`Uuid`	Oui	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Oui	—
`is_enabled`	`boolean`	Oui	—
`brief`	`string`	Non	—
`tone`	`string`	Non	—
`word_count`	`integer`	Non	—
`language`	`string`	Non	BCP-47, or empty for "the language the brief is written in".
`posts_per_run`	`integer`	Non	⛔ 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`	Non	Blank = whatever the funding route resolves to.
`model_id`	`string`	Non	Blank = the newest verified model in the family.
`model_family`	`string`	Non	—
`anchors`	`AiAnchor[]`	Non	—
`anchor_policy`	`string<none, every_post, rotate>`	Non	—
`link_set_id`	`string`	Non	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>`	Oui	—
`cadence_hour_utc`	`integer`	Non	—
`cadence_dow`	`integer`	Non	0 = Monday.
`cadence_dom`	`integer`	Non	⛔ 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`	Non	—
`last_run_at`	`object`	Non	—
`target_kind`	`string<none, sites, site_group, cms_targets>`	Non	—
`target_sites`	`string[]`	Non	—
`target_site_group_id`	`object`	Non	—
`target_cms_target_ids`	`string[]`	Non	—
`target_category`	`string`	Non	—
`requires_capabilities`	`string[]`	Non	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>`	Non	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`	Non	—
`image_model`	`string`	Non	—
`featured_image`	`boolean`	Non	—
`inline_image_count`	`integer`	Non	—
`inline_placement`	`string<after_intro, between_sections, end>`	Non	—
`image_style`	`string`	Non	—
`publish_mode`	`string<draft, schedule, publish>`	Oui	⚖️ 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`	Non	—
`schedule_stagger_minutes`	`integer`	Non	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[]`	Non	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`	Oui	—
`updated_at`	`string`	Non	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429