GovDash
Menu

Contracts

Update a contract

Changes the given fields of one contract owned by the authenticated team and returns the updated contract. Changing an amount needs permission to edit sensitive contract details. Contracts on other teams or sub-teams, or above the token's classification ceiling, are reported as not found.

patchhttps://api.govdash.us/v1/contracts/{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

Contract 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

Fields to change. Send at least one; omitted fields keep their values. Send null to clear a date or amount.

titlestring

Contract title. It can be replaced but not cleared.

start_datestring (date-time) | null

Start of the period of performance.

current_end_datestring (date-time) | null

End of the currently exercised period of performance.

ultimate_end_datestring (date-time) | null

End of the full period of performance, including all options.

award_valuenumber | null

Base award amount in US dollars.

obligated_amountnumber | null

Amount obligated by the agency in US dollars.

current_valuenumber | null

Current contract value in US dollars: the base and all exercised options.

ceiling_valuenumber | null

Ceiling contract value in US dollars: the value including all options.

Response

200 · application/json

A contract award the team tracks. Amounts are null when the token's user cannot read sensitive contract details.

idstring

Contract identifier.

objectstring

Object type, always contract.

team_idstring

Team that owns the contract.

updated_atstring (date-time)

When the contract was last updated.

titlestring

Contract title.

contract_numberstring | null

Canonical contract identifier, derived from the contract, task order and subcontract numbers the contract has.

statusenum

Processing status of the contract.

One of:UNPROCESSEDPROCESSING_DOCUMENTSPROCESSING_AWARDFAILEDFINALIZEDDELETING

classificationenum

Data classification of the contract.

One of:UNCLASSIFIEDCUI

awarding_agency_idstring | null

Identifier of the awarding agency.

funding_agency_idstring | null

Identifier of the funding agency.

vendor_idstring | null

Identifier of the company that holds the contract.

start_datestring (date-time) | null

Start of the period of performance.

current_end_datestring (date-time) | null

End of the currently exercised period of performance.

ultimate_end_datestring (date-time) | null

End of the full period of performance, including all options.

past_performanceobject | null

Primary past performance, included in detail and write responses. Null when none is recorded. Use expand[]=past_performance.writeups on retrieval for write-up summaries.

Show child attributes
idstring
descriptionstring | null
business_partner_idsstring[]
writeupsobject[]
Show child attributes
idstring
namestring
is_primaryboolean
updated_atstring (date-time)

When the write-up was last updated.

award_valuenumber | null

Base award amount in US dollars.

obligated_amountnumber | null

Amount obligated by the agency in US dollars.

current_valuenumber | null

Current contract value in US dollars: the base and all exercised options.

ceiling_valuenumber | null

Ceiling contract value in US dollars: the value including all options.

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/contracts/{id}

Update a contract

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

Path parameters
string, required

Contract 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.