Organisations
Change an embed link's websites, end or name
Keeps the address.
PATCH
/orgs/{org}/diagrams/{id}/embed-links/{link}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Change an embed link's websites, end or name. |
| What does it take? | A JSON body of type UpdateEmbedLinkBody. |
| What does it return? | Status 200 with a body of type EmbedLink. |
| What can go wrong? | 400 a website is not a host name, or the end is not allowed; 401 not signed in; 403 not on the plan, the setting is off, the role may not, or the request came from an origin that may not make changes; 404 no such organisation, diagram or link, or the caller is not a member, or the diagram is in a folder the caller may not use; 409 labelled Confidential, or waiting for approval; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Keeps the address. The same people and checks as making one.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes | |
link | string | yes | The embed link's id. |
Request body
The body has the type UpdateEmbedLinkBody.
| Field | Type | Required | Description |
|---|---|---|---|
sites | string[] | no | |
expiresAt | integer | null | no | |
label | string | null | no | at most 80 characters. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The link now. | EmbedLink |
| 400 | A website is not a host name, or the end is not allowed. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Not on the plan, the setting is off, the role may not, or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, diagram or link, or the caller is not a member, or the diagram is in a folder the caller may not use. | ErrorResponse |
| 409 | Labelled Confidential, or waiting for approval. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type EmbedLink.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
diagramId | string | yes | |
url | string | null | yes | The address, {EMBED_URL}/o/<token>.svg. A page on one of sites that shows it as an image gets the picture, without its source; anything else gets a placeholder. Null when the server cannot show it again: rotate the link for a new one. |
label | string | null | yes | An optional name for the page it is for. |
sites | string[] | yes | The websites a page must be on, lower case. |
proxiedSites | string[] | yes | Sites in sites whose images reach Plotwork through a proxy that names no page (GitHub), so the link shows them the placeholder. |
expiresAt | integer | null | yes | When it stops, in milliseconds since the epoch, or null for never. |
expired | boolean | yes | |
createdBy | string | null | yes | |
createdAt | integer | yes | |
updatedAt | integer | yes | |
rotatedAt | integer | null | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |