Update filter
curl --request PATCH \
--url https://api.vollna.com/v1/filters/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-TOKEN: <api-key>' \
--data '
{
"patch": {},
"name": "<string>"
}
'import requests
url = "https://api.vollna.com/v1/filters/{id}"
payload = {
"patch": {},
"name": "<string>"
}
headers = {
"X-API-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({patch: {}, name: '<string>'})
};
fetch('https://api.vollna.com/v1/filters/{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://api.vollna.com/v1/filters/{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([
'patch' => [
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-TOKEN: <api-key>"
],
]);
$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://api.vollna.com/v1/filters/{id}"
payload := strings.NewReader("{\n \"patch\": {},\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-TOKEN", "<api-key>")
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://api.vollna.com/v1/filters/{id}")
.header("X-API-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patch\": {},\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vollna.com/v1/filters/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patch\": {},\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"status": "active",
"visibility": "shared_edit",
"qualifier": {
"enabled": true,
"mode": "manual",
"showOnlyQualified": true,
"qualifierId": 123,
"name": "<string>",
"prompt": "<string>",
"model": "<string>"
},
"notificationsOn": true,
"summary": {},
"criteria": {
"keywords": {
"mode": "list",
"include": [
"<string>"
],
"exclude": [
"<string>"
],
"query": "<string>",
"useNegative": false,
"searchIn": {
"title": true,
"description": true,
"skills": true
},
"excludeIn": {
"title": true,
"description": true,
"skills": true
}
},
"budget": {
"fixedMin": 123,
"fixedMax": 123,
"hourlyMin": 123,
"hourlyMax": 123,
"includeHourly": true,
"includeFixed": true,
"hideWithoutBudget": false,
"filterByLowerRange": false
},
"connects": {
"min": 123,
"max": 123
},
"descriptionChars": {
"min": 123,
"max": 123
},
"sites": {
"include": [
123
],
"exclude": [
123
],
"categories": {},
"categoriesExclude": {}
},
"client": {
"paymentVerified": false,
"enterprise": false,
"totalSpentMin": 0,
"hiresMin": 0,
"ratingMin": 0,
"reviewsMin": 0,
"avgHourlyPaidMin": 0,
"hireRateMin": 0,
"rankMin": 0,
"registration": {
"mode": "specific",
"after": "2023-12-25",
"before": "2023-12-25",
"operator": "more",
"value": 123,
"unit": "months"
},
"locations": {
"include": [
{
"type": "country",
"id": 123
}
],
"exclude": [
{
"type": "country",
"id": 123
}
],
"includeUnknown": true
}
},
"project": {
"locations": {
"include": [
{
"type": "country",
"id": 123
}
],
"exclude": [
{
"type": "country",
"id": 123
}
],
"includeUnknown": true
},
"languages": {
"mode": "include",
"codes": [
"<string>"
]
},
"languageQualifications": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"usJobsMode": "include",
"ukJobsMode": "include"
},
"advancedPreferences": {}
},
"changedFields": [
"<string>"
]
}
}{
"error": "Validation failed",
"message": "<string>",
"fields": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Validation failed",
"message": "<string>",
"fields": {}
}{
"error": "Validation failed",
"message": "<string>",
"fields": {}
}{
"error": "<string>"
}Filters
Update filter
Changes the filter’s criteria and, optionally, its name. patch holds only the criteria keys to change. A list or map in it replaces the whole value, and null clears a bound such as budget.fixedMin. The status stays as it is. Check the effect first with POST /filters//preview
PATCH
/
filters
/
{id}
Update filter
curl --request PATCH \
--url https://api.vollna.com/v1/filters/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-TOKEN: <api-key>' \
--data '
{
"patch": {},
"name": "<string>"
}
'import requests
url = "https://api.vollna.com/v1/filters/{id}"
payload = {
"patch": {},
"name": "<string>"
}
headers = {
"X-API-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({patch: {}, name: '<string>'})
};
fetch('https://api.vollna.com/v1/filters/{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://api.vollna.com/v1/filters/{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([
'patch' => [
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-TOKEN: <api-key>"
],
]);
$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://api.vollna.com/v1/filters/{id}"
payload := strings.NewReader("{\n \"patch\": {},\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-TOKEN", "<api-key>")
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://api.vollna.com/v1/filters/{id}")
.header("X-API-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patch\": {},\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vollna.com/v1/filters/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patch\": {},\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"status": "active",
"visibility": "shared_edit",
"qualifier": {
"enabled": true,
"mode": "manual",
"showOnlyQualified": true,
"qualifierId": 123,
"name": "<string>",
"prompt": "<string>",
"model": "<string>"
},
"notificationsOn": true,
"summary": {},
"criteria": {
"keywords": {
"mode": "list",
"include": [
"<string>"
],
"exclude": [
"<string>"
],
"query": "<string>",
"useNegative": false,
"searchIn": {
"title": true,
"description": true,
"skills": true
},
"excludeIn": {
"title": true,
"description": true,
"skills": true
}
},
"budget": {
"fixedMin": 123,
"fixedMax": 123,
"hourlyMin": 123,
"hourlyMax": 123,
"includeHourly": true,
"includeFixed": true,
"hideWithoutBudget": false,
"filterByLowerRange": false
},
"connects": {
"min": 123,
"max": 123
},
"descriptionChars": {
"min": 123,
"max": 123
},
"sites": {
"include": [
123
],
"exclude": [
123
],
"categories": {},
"categoriesExclude": {}
},
"client": {
"paymentVerified": false,
"enterprise": false,
"totalSpentMin": 0,
"hiresMin": 0,
"ratingMin": 0,
"reviewsMin": 0,
"avgHourlyPaidMin": 0,
"hireRateMin": 0,
"rankMin": 0,
"registration": {
"mode": "specific",
"after": "2023-12-25",
"before": "2023-12-25",
"operator": "more",
"value": 123,
"unit": "months"
},
"locations": {
"include": [
{
"type": "country",
"id": 123
}
],
"exclude": [
{
"type": "country",
"id": 123
}
],
"includeUnknown": true
}
},
"project": {
"locations": {
"include": [
{
"type": "country",
"id": 123
}
],
"exclude": [
{
"type": "country",
"id": 123
}
],
"includeUnknown": true
},
"languages": {
"mode": "include",
"codes": [
"<string>"
]
},
"languageQualifications": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"usJobsMode": "include",
"ukJobsMode": "include"
},
"advancedPreferences": {}
},
"changedFields": [
"<string>"
]
}
}{
"error": "Validation failed",
"message": "<string>",
"fields": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Validation failed",
"message": "<string>",
"fields": {}
}{
"error": "Validation failed",
"message": "<string>",
"fields": {}
}{
"error": "<string>"
}Authorizations
API token for authentication
Path Parameters
Filter ID
Body
application/json
Response
Successful operation
Show child attributes
Show child attributes
Was this page helpful?