Organisations
File or rename an organisation diagram
Moves the diagram to a folder (or the top level with null) and/or renames it.
PATCH
/orgs/{org}/diagrams/{id}TL;DR
| Question | Answer |
|---|---|
| What does it do? | File or rename an organisation diagram. |
| What does it take? | A JSON body of type UpdateOrganisationDiagramBody. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 400 the body is not valid, or the folder path breaks the rules; details says why; 401 not signed in, or the key is not valid; 403 a member may change only a diagram they published and a reader none (orgs.forbidden), the folder it is moved to is restricted to others (orgs.folder_restricted), or the request came from an origin that may not make changes; 404 no such organisation or diagram, the diagram is in a folder the caller may not use, the caller is not a member, or the key belongs to another organisation; 409 the diagram is locked (hosting.diagram_locked); only the owner can unlock it. details says when it was locked and whether the caller may unlock it; 429 too many requests, or the daily limit is used up; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Moves the diagram to a folder (or the top level with null) and/or renames it. A member changes only a diagram they published; an admin, the owner, and the organisation's key change any. An invalid folder path is a 400 with the reason, never rewritten.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Request body
The body has the type UpdateOrganisationDiagramBody.
| Field | Type | Required | Description |
|---|---|---|---|
folder | string | null | no | The folder to file the diagram in, or null for the top level. |
name | string | null | no | A new label, or null to clear it. at least 1 character; at most 80 characters; pattern ^[^\p{Cc}]+$/u. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Changed. | none |
| 400 | The body is not valid, or the folder path breaks the rules; details says why. | ErrorResponse |
| 401 | Not signed in, or the key is not valid. | ErrorResponse |
| 403 | A member may change only a diagram they published and a reader none (orgs.forbidden), the folder it is moved to is restricted to others (orgs.folder_restricted), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation or diagram, the diagram is in a folder the caller may not use, the caller is not a member, or the key belongs to another organisation. | ErrorResponse |
| 409 | The diagram is locked (hosting.diagram_locked); only the owner can unlock it. details says when it was locked and whether the caller may unlock it. | ErrorResponse |
| 429 | Too many requests, or the daily limit is used up. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
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 |