links

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

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

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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.

Параметры

Имя	Тип	Обязательно	Что это
`linkSetId (path)`	`string`	Да	—

Тело запроса

Имя	Тип	Обязательно	Что это
`name`	`string`	Нет	—
`notes`	`string`	Нет	—
`is_archived`	`boolean`	Нет	—
`entries`	`LinkSetEntry[]`	Нет	—

Ответ

Имя	Тип	Обязательно	Что это
`id`	`string`	Да	—
`name`	`string`	Да	—
`notes`	`string`	Да	—
`is_archived`	`boolean`	Да	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[]`	Да	—
`created_at`	`string`	Да	—
`updated_at`	`string`	Да	—
`recipe_count`	`integer`	Да	How many recipes point at this set — so a delete button can say so first.
`distribution`	`object[]`	Да	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`	Да	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.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422

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