SignEnvoy docs

Error reference / invalid-state

Invalid state for this operation

The document is not in a state that allows this action.

Problem type /problems/invalid-state
HTTP status 409
Emitted by Signing page, REST API (/v1)
Title values
Invalid state for this operation
This signing link does not use a one-time code
Trigger
REST API (/v1): operation not valid for the envelope's state

What happened

The operation is valid in general but not for this document right now: sending a document that is already sent, editing recipients after sending, voiding a completed document, or finalizing a draft that is still waiting for its upload. The response is HTTP 409.

What it means

Nothing changed. The document’s current status decides which operations are open; structural edits are draft-only, and sending is one-way.

What to do next

Read the document (GET /v1/documents/{id}) and branch on status. If you need to change a sent document’s content or recipients, void it and create a new one; the void reason is recorded in the audit trail.

Problem body

Every error is an RFC 9457 problem document with media type application/problem+json. The type member is the stable identifier to switch on; docs_url is this page.

{
  "type": "/problems/invalid-state",
  "title": "This signing link does not use a one-time code",
  "status": 409,
  "instance": "/v1/...",
  "docs_url": "https://docs.signenvoy.com/errors/invalid-state"
}