Skip to main content

Change Document Status

Update document workflow status.

Endpoint​

PATCH /api/v3/documents/{id}/status

Request​

{
  "status": "completed"
}

Status Values​

  • draft - In progress
  • review - Ready for review
  • completed - Finalized
  • archived - Archived

Response​

{
  "id": 123,
  "status": "completed",
  "updated_at": "2025-01-17T16:00:00Z"
}

Examples​

Mark as Completed​

curl -X PATCH https://api.scriptix.io/api/v3/documents/123/status \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "completed"}'

Python​

response = requests.patch(
    'https://api.scriptix.io/api/v3/documents/123/status',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={'status': 'completed'}
)