Skip to main content
Update document
This operation exists in Discovery, but a matching public API gateway route is not configured. It is not currently available through the documented base URL.

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Path Parameters

id
string
required

Document id.

Query Parameters

team
string

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a team other than the one your API key belongs to return 403 without it.

Only API keys can use it: an OAuth access token sent with another team's id is rejected with 403 Team mismatch with OAuth token.

Optional — omit it entirely unless you are acting on another team. It deliberately carries no example value so generated snippets do not emit ?team=undefined; when the parameter is absent, the team is derived from your API key.

Example: ?team=team_xyz789

Body

application/json

Partial update. Every field is optional and only the keys present in the body are written. The file itself (documentType, fileUrl, storagePath, fileName) is immutable and those keys are rejected as unknown.

name
string | null
Example:

"Contrato de servicios 2026 — Cliente ACME (v2)"

description
string | null
complianceStatus
enum<string>

Compliance review state. Always pending_review when a document is created; change it with PATCH /v2/documents/{id}.

Available options:
pending_review,
valid,
requires_update,
expired,
rejected
Example:

"pending_review"

complianceNotes
string | null
Example:

"Revisado por el área fiscal."

validFrom
integer<int64> | null
Example:

1767225600000

validUntil
integer<int64> | null
Example:

1798761600000

tags
string[] | null
Example:
metadata
object | null

Response

Document updated.

Standardized success envelope emitted by sendSuccessResponse.

success
enum<boolean>
required
Available options:
true
Example:

true

data
object
required

A document as returned by the documents endpoints (snake_case).

timestamp
integer<int64>
required

Server time in epoch milliseconds (Luxon.now().toMillis()).

Example:

1767225600000

message
string

Human-readable summary. Present only when the handler supplies one.

Example:

"Operation completed successfully"