links
PATCH /v1/content/link-sets/{linkSetId}
Rename a link set, archive it, or replace its links.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X PATCH https://api.zinndigital.com/v1/content/link-sets/{linkSetId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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