Skip to main content
PATCH
Update a sandbox document

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

document_id
string
required

Body

application/json

A metadata-only edit. The file itself is set at create and cannot be replaced.

filename
string

Name the entry is addressed by. A rename is refused while a document-upload scenario still matches on the old name.

Maximum string length: 255
Example:

"acme-w2-2025.pdf"

documents
object[]

Test metadata describing the documents in the file, used by document-upload scenarios.

status
enum<string>

File-level processing outcome. A successful entry must declare at least one document.

Available options:
successful,
invalid,
duplicate,
failed
Example:

"invalid"

validations
object

Per-check validation results. Declaring a failure means saying which check failed.

Example:
last_error
string

Message surfaced for a failed file.

Maximum string length: 500
Example:

"The file could not be read."

Response

One file in your sandbox document library, plus the test metadata describing it.

id
string
read-only

Unique identifier of the library entry. This is the value a scenario payload references as document_id.

Maximum string length: 64
Example:

"3f1c8a90b7d2416e9a5c0e4f2b8d6a17"

uploaded_file
object

The file half of a library entry.

documents
object[]

Test metadata describing the documents in the file, used by document-upload scenarios.

created_at
string<date-time>
read-only

Time when the entry was created.

Example:

"2026-09-17T10:11:02.104882Z"

updated_at
string<date-time>
read-only

Time when the entry was last updated.

Example:

"2026-09-17T10:11:02.104901Z"