GovDash
Menu

Documents

Rename a document

Changes one document's display name and returns the updated document. Classification cannot be changed. Documents outside the authenticated team's Data Library or above the token's classification ceiling are reported as not found.

patchhttps://api.govdash.us/v1/documents/{id}

Authorization

Authorizationstringheaderrequired

Your API key as a bearer token, for example Bearer gd_live_....

See Authentication for how to create a key.

Path parameters

idstringpathrequired

Document identifier.

Headers

govdash-versionenumheaderrequired

The dated API version this request is written against. Responses keep that version's shape after newer versions ship.

One of:2026-11-17

Body

application/json
namestringrequired

Response

200 · application/json

A document in the team's Data Library.

idstring

Document identifier.

objectstring

Object type, always document.

namestring

Document display name.

classificationenum

Data classification of the document.

One of:UNCLASSIFIEDCUI

statusenum

Processing status: processing while GovDash reads the file, ready once it is usable, action_required when it needs a person to act in GovDash, failed, unsupported for files GovDash skips, or deleting.

One of:processingreadyaction_requiredfailedunsupporteddeleting

created_atstring (date-time)

When the document was created.

updated_atstring (date-time)

When the document was last updated.

uploaded_byobject | null

User who uploaded the document.

Show child attributes
idstring

User identifier.

first_namestring | null

User first name.

last_namestring | null

User last name.

download_urlstring | null

Signed link to download the file, valid for about an hour. null until the document is ready, and for documents linked from SharePoint and documents with no stored file. Present only with expand[]=download_url. Treat it as a secret.

Errors

Every error returns a stable error.code to branch on and an error.message that says what went wrong, like the examples below. See Errors for how to handle each one.

400bad_request

The body is empty, has a field this endpoint doesn't accept, or a field has the wrong type. The message names the field.

Invalid request body: Expected a value with at least 1 entry

401unauthorized

The API key is missing, mistyped, revoked, or expired.

The bearer token is missing or invalid.

403forbiddenclassification_out_of_scope

The key's service account doesn't have the permission this needs, or your team's access has ended.

You do not have permission to perform this action.

404not_found

The record doesn't exist, belongs to another team, or is above the key's classification.

The requested resource was not found.

413payload_too_large

The request body is over 1 MB.

The request body must not exceed 1 MB.

422validation_failed

The request is well formed, but GovDash won't make this change. The message says why, when it can.

The request failed validation.

429rate_limited

You sent too many requests. Wait the seconds in the retry-after header, then retry.

This access token exceeded its write rate limit.

500internal_error

Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.

An unexpected error occurred.

503service_unavailable

GovDash is briefly unavailable and didn't run the request. Retry after retry-after.

The service is temporarily unavailable. Try again later.

patch/v1/documents/{id}

Rename a document

Sends a real PATCH request that changes your team's data.

Path parameters
string, required

Document identifier.

Body

Starts with the required fields. The Body section of this page lists every field.

Bearer

Kept in this tab only. Use a key you can revoke.

Request
Response
Send the request to see the response.