Skip to content
Connect an agent

Organisations

Stop keeping a placed diagram current

Forgets the placement.

DELETE/orgs/{org}/documents/{id}

TL;DR

QuestionAnswer
What does it do?Stop keeping a placed diagram current.
What does it take?org, id in the path.
What does it return?Status 204 with no body.
What can go wrong?401 not signed in; 403 not the owner or an admin (orgs.forbidden), the plan does not include it (plan.documents_not_included), or the origin may not make changes; 404 no such organisation, diagram, placement or file, or the caller is not a member; 429 too many requests; 503 placing diagrams in documents is not available on this server (documents.unavailable). Every failure uses the one error envelope.

What it does

Forgets the placement. The picture stays in the file as it is.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.
idstringyes

Responses

StatusMeaningBody
204Forgotten.none
401Not signed in.ErrorResponse
403Not the owner or an admin (orgs.forbidden), the plan does not include it (plan.documents_not_included), or the origin may not make changes.ErrorResponse
404No such organisation, diagram, placement or file, or the caller is not a member.ErrorResponse
429Too many requests.ErrorResponse
503Placing diagrams in documents is not available on this server (documents.unavailable).ErrorResponse

See also

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