Adds a link with extra context, such as a design, to a key.
HTTP
POST /keys/{keyId}/linksAccess: Session token only. API keys get 403 with insufficient_scope.
Role: Project reviewer or manager.
Path parameters #
| Parameter | Description |
|---|---|
keyId | The id of the key. |
Request body #
JSON.
| Field | Type | Required | Description |
|---|---|---|---|
title | string | yes | At most 200 characters. |
url | string | yes | An http:// or https:// address. At most 2000 characters. |
description | string | no | At most 1000 characters. |
JSON
{ "title": "Design", "url": "https://example.com/design" }Response 201 #
The link.
JSON
{ "id": "0197a3ca-8197-7e88-9bdf-3f7c9a4e6108", "icon": "link", "title": "Design", "url": "https://example.com/design", "description": null }Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the link. |
icon | string | An icon name. |
title | string | The title. |
url | string | The address. |
description | string or null | The description. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The key does not exist, you have no access to its project, or keyId is not a UUID. |
| 403 | forbidden | You are a translator in the project. |
| 422 | invalid_request | url is not an http or https address, or a text is empty or too long. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.