links

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

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X PATCH https://api.zinndigital.com/v1/content/link-sets/{linkSetId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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.

Parameter

Name	Typ	Erforderlich	Was es ist
`linkSetId (path)`	`string`	Ja	—

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`name`	`string`	Nein	—
`notes`	`string`	Nein	—
`is_archived`	`boolean`	Nein	—
`entries`	`LinkSetEntry[]`	Nein	—

Antwort

Name	Typ	Erforderlich	Was es ist
`id`	`string`	Ja	—
`name`	`string`	Ja	—
`notes`	`string`	Ja	—
`is_archived`	`boolean`	Ja	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[]`	Ja	—
`created_at`	`string`	Ja	—
`updated_at`	`string`	Ja	—
`recipe_count`	`integer`	Ja	How many recipes point at this set — so a delete button can say so first.
`distribution`	`object[]`	Ja	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`	Ja	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.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422

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