GovDash
Menu

Opportunities

Update an opportunity

Changes the given fields of one opportunity owned by the authenticated team and returns the updated opportunity. Opportunities on other teams, or above the token's classification ceiling, are reported as not found.

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

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

titlestring

Opportunity name.

descriptionstring | null

Opportunity description.

phase_idstring

Phase identifier from GET /v1/meta/phases to move the opportunity to.

solicitation_numberstring

Solicitation number. It can be replaced but not cleared.

agency_idstring | null

Identifier of the issuing agency.

estimated_valuenumber | null

Estimated contract value in US dollars.

due_datestring (date-time) | null

Response due date.

posted_datestring (date-time) | null

When the notice was posted.

Response

200 · application/json

An opportunity the team is tracking.

idstring

Opportunity identifier.

objectstring

Object type, always opportunity.

team_idstring

Team that owns the opportunity.

created_atstring (date-time)

When the opportunity was created.

updated_atstring (date-time)

When the opportunity was last updated.

titlestring

Opportunity name.

descriptionstring | null

Opportunity description.

phaseobject
Show child attributes
idstring

Phase identifier.

namestring

Phase name.

solicitation_numberstring | null

Solicitation number.

agency_idstring | null

Identifier of the issuing agency.

estimated_valuenumber | null

Estimated contract value in US dollars.

due_datestring (date-time) | null

Response due date.

posted_datestring (date-time) | null

When the notice was posted.

source_urlstring | null

Link to the opportunity at its source.

classificationenum

Data classification of the opportunity.

One of:UNCLASSIFIEDCUI

custom_fieldsobject[]

Custom field values set on the opportunity. Present only with expand[]=custom_fields.

Show child attributes
field_idstring

Custom field identifier.

namestring

Custom field name.

typeenum

Custom field type, which determines the shape of value.

One of:TEXTTEXTAREANUMBERNUMBER_RANGECURRENCYCURRENCY_RANGEDATEDATE_RANGEBOOLEANSELECTMULTI_SELECTURLPERCENTAGEFORMULARATING

valueany

Value set on the opportunity.

membersobject[]

Capture team members. Present only with expand[]=members.

Show child attributes
idstring

Member assignment identifier.

roleobject
Show child attributes
idstring

Member role identifier.

namestring

Member role name.

userobject | null

Team user assigned to the role.

Show child attributes
idstring

User identifier.

first_namestring | null

User first name.

last_namestring | null

User last name.

emailstring

User email address.

key_person_idstring | null

Identifier of the key person assigned to the role.

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.

409conflict

A record like this already exists. Use it instead of creating another.

The request conflicts with an existing resource.

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, such as moving the opportunity into a phase whose required fields it doesn't have yet. The message says why, when it can.

Missing required field in Qualify: Contract vehicle

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

Update an opportunity

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

Path parameters
string, required

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