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
Your API key as a bearer token, for example Bearer gd_live_....
See Authentication for how to create a key.
Path parameters
Document identifier.
Headers
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Body
application/jsonResponse
200 · application/jsonA document in the team's Data Library.
Document identifier.
Object type, always document.
Document display name.
Data classification of the document.
One of:
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:
When the document was created.
When the document was last updated.
User who uploaded the document.
Show child attributesHide child attributes
User identifier.
User first name.
User last name.
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.
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
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.
The record doesn't exist, belongs to another team, or is above the key's classification.
The requested resource was not found.
The request is well formed, but GovDash won't make this change. The message says why, when it can.
The request failed validation.
You sent too many requests. Wait the seconds in the retry-after header, then retry.
This access token exceeded its write rate limit.
Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.
An unexpected error occurred.
GovDash is briefly unavailable and didn't run the request. Retry after retry-after.
The service is temporarily unavailable. Try again later.