Markdown to PDF

API documentation

Delete a managed document

Documents

Delete a managed document

Request deletion of the document, all immutable sources, previews, final artifacts, and active lifecycle work.

DELETE/api/v2/documents/{documentId}
Required scopedocuments.delete

Parameters

documentId
pathstring<uuid>required

Owner-scoped managed document identifier.

Request body

This operation does not accept a request body.

Operational behavior

Idempotency

Mode: resource idempotent. No idempotency header is required.

Retries

Repeat DELETE for the same document ID. already_deleting and already_deleted are successful idempotent outcomes. Retry statuses: 429, 503. Honor Retry-After.

Retention

Deletion tombstones immediately, cancels active work, deletes private objects first, and then redacts content metadata under the retention sweeper. Response field: retention.

Responses

200Deletion was already in progress or complete.

Response headers

X-Correlation-Id

Response schema

DeletionResponse

Deletion Response object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

documentId
string<uuid>required

Document Id value.

retention
objectrequired

Retention value.

status
stringrequired

Status value.

  • Allowed: accepted, already_deleting, already_deleted
200 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "documentId": "11111111-1111-4111-8111-111111111111",
  "retention": {
    "deleteRequestedAt": "2026-07-20T12:20:00.000Z",
    "deletedAt": null,
    "expiresAt": "2026-08-19T12:00:00.000Z",
    "policy": "managed_default"
  },
  "status": "accepted"
}
202Deletion was accepted and object-first cleanup is pending.

Response headers

X-Correlation-Id

Response schema

DeletionResponse

Deletion Response object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

documentId
string<uuid>required

Document Id value.

retention
objectrequired

Retention value.

status
stringrequired

Status value.

  • Allowed: accepted, already_deleting, already_deleted
202 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "documentId": "11111111-1111-4111-8111-111111111111",
  "retention": {
    "deleteRequestedAt": "2026-07-20T12:20:00.000Z",
    "deletedAt": null,
    "expiresAt": "2026-08-19T12:00:00.000Z",
    "policy": "managed_default"
  },
  "status": "accepted"
}
401The bearer credential is missing, malformed, expired, revoked, or belongs to the wrong environment.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

error
objectrequired

Error value.

401 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authentication",
    "code": "unauthorized",
    "httpStatus": 401,
    "message": "A valid API key is required.",
    "retryable": false
  }
}
403The principal is authenticated but lacks the operation's required scope.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

error
objectrequired

Error value.

403 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "forbidden",
    "httpStatus": 403,
    "message": "The API key does not have the required scope.",
    "retryable": false
  }
}
404The resource does not exist or is not visible to this principal. Cross-tenant misses use the same response.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

error
objectrequired

Error value.

404 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "not_found",
    "httpStatus": 404,
    "message": "The requested resource was not found.",
    "retryable": false
  }
}
429The request is temporarily rate limited. No final publication unit is consumed.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

error
objectrequired

Error value.

429 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "entitlement",
    "code": "rate_limited",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 429,
    "message": "Too many publishing requests. Retry after 30 seconds.",
    "retryable": true
  }
}
503A transient publishing, queue, renderer, or storage dependency is unavailable. No failed render consumes a final publication unit.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion
stringrequired

Contract Version value.

error
objectrequired

Error value.

503 example
{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "internal",
    "code": "service_unavailable",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 503,
    "message": "Publishing is temporarily unavailable.",
    "retryable": true
  }
}

Checking API access

Loading your activation state.