links

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

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

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`linkSetId (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Não	—
`notes`	`string`	Não	—
`is_archived`	`boolean`	Não	—
`entries`	`LinkSetEntry[]`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`name`	`string`	Sim	—
`notes`	`string`	Sim	—
`is_archived`	`boolean`	Sim	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[]`	Sim	—
`created_at`	`string`	Sim	—
`updated_at`	`string`	Sim	—
`recipe_count`	`integer`	Sim	How many recipes point at this set — so a delete button can say so first.
`distribution`	`object[]`	Sim	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`	Sim	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.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

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