GovDash
Menu

Agents

Update an agent

Updates an agent and returns the full object. Triggers replace the complete saved set and re-sync Temporal schedules; omit triggers to keep them unchanged.

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

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 update; omitted fields retain their values.

namestring
goal_promptstring
visibilityenum

One of:PERSONALTEAM

run_as_user_idstring
enabledboolean
tool_bundlesenum[]

One of:WEB_SEARCHDATA_LIBRARY_DOCUMENTSDATA_LIBRARY_STAFFING_POOLDATA_LIBRARY_COMPANIESCAPTUREPROPOSALCONTRACTPRICERDISCOVERDISCOVER_PRIVATEDOCUMENT_GENERATIONTASKSGMAILDRIVEGOOGLE_CALENDARUSA_SPENDINGREPORTSCALENDARCOREEXTENSION_WEBPAGEHELP_CENTERDEVTOOLSTEAMING_EVALSUGGESTED_PARTNERSHIPSHAREPOINT_FILE_SEARCHOUTLINE_AGENTENTITY_EXTRACTION

mcp_connectorsstring[]
skillsstring[]
child_agent_idsstring[]
web_domain_allowliststring[]
triggersobject[]

Full replacement trigger set. An empty array removes all triggers and their schedules. SCHEDULE requires cron_expression and timezone.

Show child attributes
typeenumrequired

One of:OUTLOOK_EMAIL_RECEIVEDMANUALMONITORSCHEDULEOPPORTUNITY_CREATEDOPPORTUNITY_STAGE_CHANGEDPROPOSAL_CREATEDDOCUMENT_UPLOADEDOPPORTUNITY_DOCUMENT_UPLOADEDPROPOSAL_SOLICITATION_DOCUMENT_ADDEDCONTRACT_DOCUMENT_UPLOADEDCONTRACT_AWARDED

enabledboolean
cron_expressionstring
timezonestring
mailboxobject
Show child attributes
account_idstringrequired
tenant_idstringrequired
subscriber_idsstring[]
avatar_idstring
chat_delivery_destinationsobject[]
Show child attributes
providerenumrequired

One of:SLACKGOV_SLACKTEAMSTEAMS_GCC_HIGH

destinationobjectrequired
chat_delivery_emailboolean

Response

200 · application/json
idstring
objectstring
team_idstring
created_atstring (date-time)

When the agent was created.

updated_atstring (date-time)

When the agent was last updated.

namestring
goal_promptstring
enabledboolean
visibilityenum

One of:PERSONALTEAM

owner_user_idstring
run_as_user_idstring
versioninteger
tool_bundlesenum[]

One of:WEB_SEARCHDATA_LIBRARY_DOCUMENTSDATA_LIBRARY_STAFFING_POOLDATA_LIBRARY_COMPANIESCAPTUREPROPOSALCONTRACTPRICERDISCOVERDISCOVER_PRIVATEDOCUMENT_GENERATIONTASKSGMAILDRIVEGOOGLE_CALENDARUSA_SPENDINGREPORTSCALENDARCOREEXTENSION_WEBPAGEHELP_CENTERDEVTOOLSTEAMING_EVALSUGGESTED_PARTNERSHIPSHAREPOINT_FILE_SEARCHOUTLINE_AGENTENTITY_EXTRACTION

mcp_connectorsstring[]
skillsstring[]
child_agent_idsstring[]
web_domain_allowliststring[]
triggersobject[]
Show child attributes
typeenum

One of:OUTLOOK_EMAIL_RECEIVEDMANUALMONITORSCHEDULEOPPORTUNITY_CREATEDOPPORTUNITY_STAGE_CHANGEDPROPOSAL_CREATEDDOCUMENT_UPLOADEDOPPORTUNITY_DOCUMENT_UPLOADEDPROPOSAL_SOLICITATION_DOCUMENT_ADDEDCONTRACT_DOCUMENT_UPLOADEDCONTRACT_AWARDED

enabledboolean
cron_expressionstring | null
timezonestring | null
chat_delivery_destinationsobject[]
Show child attributes
providerenum

One of:SLACKGOV_SLACKTEAMSTEAMS_GCC_HIGH

destinationobject
chat_delivery_emailboolean
pro_team_agent_idstring | null

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

Update an agent

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

Path parameters
string, required
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.