links

PATCH `/v1/content/link-sets/{linkSetId}`

Rename a link set, archive it, or replace its links.

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

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/content/link-sets/{linkSetId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Gated on `links.edit`. Sending `entries` replaces the whole list. That is safe for a link's placement history because the history is keyed on the URL and wording, not on a row id — so editing the list does not reset how often a link has been used.

Paramètres

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

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`name`	`string`	Non	—
`notes`	`string`	Non	—
`is_archived`	`boolean`	Non	—
`entries`	`LinkSetEntry[]`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	—
`name`	`string`	Oui	—
`notes`	`string`	Oui	—
`is_archived`	`boolean`	Oui	An archived set is hidden from the picker and takes no new recipes; the recipes already using it keep working. Archiving is offered where deleting is refused.
`entries`	`LinkSetEntry[]`	Oui	—
`created_at`	`string`	Oui	—
`updated_at`	`string`	Oui	—
`recipe_count`	`integer`	Oui	How many recipes point at this set — so a delete button can say so first.
`distribution`	`object[]`	Oui	The resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses.
`distribution_error`	`string`	Oui	Why there is no distribution, or empty. Separate from `distribution` because an empty list also means "this set has no links", and one value for two facts is not an answer.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422

PATCH /v1/content/link-sets/{linkSetId}