Skip to main content
PATCH
Update an opportunity saved search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
customFields
object[] | null

Patch organization-defined fields using keys and types returned in customFields. Omitted, null, or empty arrays preserve values. Each supplied key changes only that field; value null clears it. Unknown, archived, duplicate, or incorrectly typed fields reject the whole edit. Text identifiers retain leading zeros.

name
string
query
string
searchType
enum<string>
Available options:
fed,
sled,
international
buyerIds
string[]
includeSubBuyers
boolean
naics
string[]
placeIds
string[]

Canonical Govly Place ids to scope the saved search to. Replaces the stored set; an empty array does not clear it.

placeIdsNone
string[]

Canonical Govly Place ids to exclude.

recordType
string[]
noticeType
string[]
status
string[]
dateRangeParam
string
relativeStartDayPivot
integer
relativeEndDayPivot
integer
active
boolean

Set false to stop the saved search matching and notifying.

Response

Updated opportunity saved search

data
object
required