Update an award saved search
curl --request PATCH \
--url https://app.govly.com/api/tools/v1/awards/saved_searches/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"query": "<string>",
"recipientNames": [
"<string>"
],
"buyerNames": [
"<string>"
],
"funderNames": [
"<string>"
],
"naics": [
"<string>"
],
"psc": [
"<string>"
],
"amountRange": [
123
],
"placeIds": [
"<string>"
],
"placeIdsNone": [
"<string>"
],
"dateRangeParam": "<string>",
"relativeStartDayPivot": 123,
"relativeEndDayPivot": 123,
"active": true
}
'import requests
url = "https://app.govly.com/api/tools/v1/awards/saved_searches/{id}"
payload = {
"name": "<string>",
"query": "<string>",
"recipientNames": ["<string>"],
"buyerNames": ["<string>"],
"funderNames": ["<string>"],
"naics": ["<string>"],
"psc": ["<string>"],
"amountRange": [123],
"placeIds": ["<string>"],
"placeIdsNone": ["<string>"],
"dateRangeParam": "<string>",
"relativeStartDayPivot": 123,
"relativeEndDayPivot": 123,
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
query: '<string>',
recipientNames: ['<string>'],
buyerNames: ['<string>'],
funderNames: ['<string>'],
naics: ['<string>'],
psc: ['<string>'],
amountRange: [123],
placeIds: ['<string>'],
placeIdsNone: ['<string>'],
dateRangeParam: '<string>',
relativeStartDayPivot: 123,
relativeEndDayPivot: 123,
active: true
})
};
fetch('https://app.govly.com/api/tools/v1/awards/saved_searches/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.govly.com/api/tools/v1/awards/saved_searches/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'query' => '<string>',
'recipientNames' => [
'<string>'
],
'buyerNames' => [
'<string>'
],
'funderNames' => [
'<string>'
],
'naics' => [
'<string>'
],
'psc' => [
'<string>'
],
'amountRange' => [
123
],
'placeIds' => [
'<string>'
],
'placeIdsNone' => [
'<string>'
],
'dateRangeParam' => '<string>',
'relativeStartDayPivot' => 123,
'relativeEndDayPivot' => 123,
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.govly.com/api/tools/v1/awards/saved_searches/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"recipientNames\": [\n \"<string>\"\n ],\n \"buyerNames\": [\n \"<string>\"\n ],\n \"funderNames\": [\n \"<string>\"\n ],\n \"naics\": [\n \"<string>\"\n ],\n \"psc\": [\n \"<string>\"\n ],\n \"amountRange\": [\n 123\n ],\n \"placeIds\": [\n \"<string>\"\n ],\n \"placeIdsNone\": [\n \"<string>\"\n ],\n \"dateRangeParam\": \"<string>\",\n \"relativeStartDayPivot\": 123,\n \"relativeEndDayPivot\": 123,\n \"active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.govly.com/api/tools/v1/awards/saved_searches/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"recipientNames\": [\n \"<string>\"\n ],\n \"buyerNames\": [\n \"<string>\"\n ],\n \"funderNames\": [\n \"<string>\"\n ],\n \"naics\": [\n \"<string>\"\n ],\n \"psc\": [\n \"<string>\"\n ],\n \"amountRange\": [\n 123\n ],\n \"placeIds\": [\n \"<string>\"\n ],\n \"placeIdsNone\": [\n \"<string>\"\n ],\n \"dateRangeParam\": \"<string>\",\n \"relativeStartDayPivot\": 123,\n \"relativeEndDayPivot\": 123,\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.govly.com/api/tools/v1/awards/saved_searches/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"recipientNames\": [\n \"<string>\"\n ],\n \"buyerNames\": [\n \"<string>\"\n ],\n \"funderNames\": [\n \"<string>\"\n ],\n \"naics\": [\n \"<string>\"\n ],\n \"psc\": [\n \"<string>\"\n ],\n \"amountRange\": [\n 123\n ],\n \"placeIds\": [\n \"<string>\"\n ],\n \"placeIdsNone\": [\n \"<string>\"\n ],\n \"dateRangeParam\": \"<string>\",\n \"relativeStartDayPivot\": 123,\n \"relativeEndDayPivot\": 123,\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"active": true,
"criteria": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}Saved Searches
Update an award saved search
Merges the supplied criteria into the stored ones. Only supplied keys change; omitted keys are left as they are, and there is no way to remove a stored filter — recreate the saved search to clear one. Award saved searches do not send notifications.
PATCH
/
api
/
tools
/
v1
/
awards
/
saved_searches
/
{id}
Update an award saved search
curl --request PATCH \
--url https://app.govly.com/api/tools/v1/awards/saved_searches/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"query": "<string>",
"recipientNames": [
"<string>"
],
"buyerNames": [
"<string>"
],
"funderNames": [
"<string>"
],
"naics": [
"<string>"
],
"psc": [
"<string>"
],
"amountRange": [
123
],
"placeIds": [
"<string>"
],
"placeIdsNone": [
"<string>"
],
"dateRangeParam": "<string>",
"relativeStartDayPivot": 123,
"relativeEndDayPivot": 123,
"active": true
}
'import requests
url = "https://app.govly.com/api/tools/v1/awards/saved_searches/{id}"
payload = {
"name": "<string>",
"query": "<string>",
"recipientNames": ["<string>"],
"buyerNames": ["<string>"],
"funderNames": ["<string>"],
"naics": ["<string>"],
"psc": ["<string>"],
"amountRange": [123],
"placeIds": ["<string>"],
"placeIdsNone": ["<string>"],
"dateRangeParam": "<string>",
"relativeStartDayPivot": 123,
"relativeEndDayPivot": 123,
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
query: '<string>',
recipientNames: ['<string>'],
buyerNames: ['<string>'],
funderNames: ['<string>'],
naics: ['<string>'],
psc: ['<string>'],
amountRange: [123],
placeIds: ['<string>'],
placeIdsNone: ['<string>'],
dateRangeParam: '<string>',
relativeStartDayPivot: 123,
relativeEndDayPivot: 123,
active: true
})
};
fetch('https://app.govly.com/api/tools/v1/awards/saved_searches/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.govly.com/api/tools/v1/awards/saved_searches/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'query' => '<string>',
'recipientNames' => [
'<string>'
],
'buyerNames' => [
'<string>'
],
'funderNames' => [
'<string>'
],
'naics' => [
'<string>'
],
'psc' => [
'<string>'
],
'amountRange' => [
123
],
'placeIds' => [
'<string>'
],
'placeIdsNone' => [
'<string>'
],
'dateRangeParam' => '<string>',
'relativeStartDayPivot' => 123,
'relativeEndDayPivot' => 123,
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.govly.com/api/tools/v1/awards/saved_searches/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"recipientNames\": [\n \"<string>\"\n ],\n \"buyerNames\": [\n \"<string>\"\n ],\n \"funderNames\": [\n \"<string>\"\n ],\n \"naics\": [\n \"<string>\"\n ],\n \"psc\": [\n \"<string>\"\n ],\n \"amountRange\": [\n 123\n ],\n \"placeIds\": [\n \"<string>\"\n ],\n \"placeIdsNone\": [\n \"<string>\"\n ],\n \"dateRangeParam\": \"<string>\",\n \"relativeStartDayPivot\": 123,\n \"relativeEndDayPivot\": 123,\n \"active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.govly.com/api/tools/v1/awards/saved_searches/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"recipientNames\": [\n \"<string>\"\n ],\n \"buyerNames\": [\n \"<string>\"\n ],\n \"funderNames\": [\n \"<string>\"\n ],\n \"naics\": [\n \"<string>\"\n ],\n \"psc\": [\n \"<string>\"\n ],\n \"amountRange\": [\n 123\n ],\n \"placeIds\": [\n \"<string>\"\n ],\n \"placeIdsNone\": [\n \"<string>\"\n ],\n \"dateRangeParam\": \"<string>\",\n \"relativeStartDayPivot\": 123,\n \"relativeEndDayPivot\": 123,\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.govly.com/api/tools/v1/awards/saved_searches/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"recipientNames\": [\n \"<string>\"\n ],\n \"buyerNames\": [\n \"<string>\"\n ],\n \"funderNames\": [\n \"<string>\"\n ],\n \"naics\": [\n \"<string>\"\n ],\n \"psc\": [\n \"<string>\"\n ],\n \"amountRange\": [\n 123\n ],\n \"placeIds\": [\n \"<string>\"\n ],\n \"placeIdsNone\": [\n \"<string>\"\n ],\n \"dateRangeParam\": \"<string>\",\n \"relativeStartDayPivot\": 123,\n \"relativeEndDayPivot\": 123,\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"active": true,
"criteria": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>"
}
}
]
}Authorizations
bearerApiKeyheaderApiKey
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Available options:
fed, sled, international Required array length:
2 elementsCanonical Govly Place ids to scope the saved search to. Replaces the stored set; an empty array does not clear it.
Canonical Govly Place ids to exclude.
Set false to deactivate the saved search.
Response
Updated award saved search
Show child attributes
Show child attributes
Was this page helpful?
⌘I