SignEnvoy docs

Error reference / folder-invalid

Folder change refused

A folder operation or a document's folder assignment was not valid for this workspace.

Problem type /problems/folder-invalid
HTTP status 422
Emitted by REST API (/v1)
Title values
Folder change refused
Trigger
REST API (/v1): folder does not exist in the workspace, duplicate name at that level, move into itself/a descendant, or deeper than 5 (D57)

What happened

A POST /v1/folders, PATCH /v1/folders/{id}, GET /v1/documents?folder=, or PATCH /v1/documents/{id} with a folder_id named something the workspace’s folder tree cannot hold. The response is HTTP 422 with this slug, and detail says which rule applied: the folder does not exist in this workspace, a folder with that name already exists at the same level, the move would put a folder inside itself or one of its own subfolders, or the tree would become deeper than 5 levels.

What it means

Folders are organization only. They never change a document’s recipients, validity, or signing links, so nothing about the document itself was touched. Folder ids are plain UUIDs scoped to the workspace; another workspace’s folder id counts as nonexistent.

What to do next

Read detail, then retry with a folder that exists (GET /v1/folders lists the tree with each folder’s parent_id and depth), a different name, or a shallower position.

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/folder-invalid",
  "title": "Folder change refused",
  "status": 422,
  "instance": "/v1/...",
  "docs_url": "https://docs.signenvoy.com/errors/folder-invalid"
}