Documents API: Delete document

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/documents/delete_document
Handler	OperatelyWeb.Api.Documents.Delete

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
document_id	id primitive (encoded as string)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
document	document	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/documents/delete_document" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"document_id":"value"}'

Response Example#

{
  "document": "<document>"
}