Skip to content
Connect an agent

Organisations

Keep a diagram from the library retention

True keeps the diagram whatever "Delete library diagrams not updated for" says; the plan's own retention still applies.

PUT/orgs/{org}/diagrams/{id}/kept

TL;DR

QuestionAnswer
What does it do?Keep a diagram from the library retention.
What does it take?A JSON body of type SetDiagramKeptBody.
What does it return?Status 200 with a body of type DiagramKept.
What can go wrong?400 the body is not valid; 401 not signed in; 403 the role may not (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation or diagram, or the caller is not a member, or the diagram is in a folder the caller may not use; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope.

What it does

True keeps the diagram whatever "Delete library diagrams not updated for" says; the plan's own retention still applies. The owner and admins.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.
idstringyes

Request body

The body has the type SetDiagramKeptBody.

FieldTypeRequiredDescription
keptbooleanyesTrue keeps the diagram from the library retention; false lets it go when it is due.

Responses

StatusMeaningBody
200The diagram's value now.DiagramKept
400The body is not valid.ErrorResponse
401Not signed in.ErrorResponse
403The role may not (orgs.forbidden), or the request came from an origin that may not make changes.ErrorResponse
404No such organisation or diagram, or the caller is not a member, or the diagram is in a folder the caller may not use.ErrorResponse
429Too many requests.ErrorResponse
503Organisations are not set up on this server.ErrorResponse

Response body

A 200 answer has the type DiagramKept.

FieldTypeRequiredDescription
idstringyes
keptbooleanyes

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools