Patch Screener
ScreenerPatchScreenerResponse v1().screener().patchScreener(ScreenerPatchScreenerParamsparams = ScreenerPatchScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PATCH/v1/saved-screeners/{screener_id}
Partially update a saved screener configuration.
Every field is optional. Omitting a field, or sending it as null,
leaves the stored value unchanged. Sending a field’s empty value clears
it: columns: [] clears the stored columns, sorts: [] clears the
stored sort, and filters: [] clears the stored filters. name: "" is
rejected — a screener’s name cannot be cleared. shared: false sets it
to false; it is a value, not a clear.
Unknown fields are rejected with a 422.
Patch Screener
package com.clearstreet.api.example;
import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.screener.ScreenerPatchScreenerParams;
import com.clearstreet.api.models.v1.screener.ScreenerPatchScreenerResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
ClearStreetClient client = ClearStreetOkHttpClient.builder()
.fromEnv()
.apiKey("My API Key")
.build();
ScreenerPatchScreenerResponse response = client.v1().screener().patchScreener("550e8400-e29b-41d4-a716-446655440000");
}
}{
"data": {
"columns": [
{
"name": "symbol"
},
{
"name": "price"
},
{
"name": "market_cap"
}
],
"created_at": "2026-04-23T13:37:04.041398Z",
"filters": [
{
"left": {
"name": "market_cap"
},
"op": {
"name": "GREATER_OR_EQUAL"
},
"right": [
{
"value": 1000000000
}
]
}
],
"id": "69fcb40a-1812-4856-b2d3-97dec805efee",
"name": "Tech Large Caps",
"sorts": [
{
"direction": "ASC",
"field": {
"name": "market_cap"
}
}
],
"updated_at": "2026-04-23T13:37:21.860106Z"
},
"metadata": {
"request_id": "71ac58a8-9b12-49b9-8301-6239febe4e56"
}
}{
"error": {
"code": 400,
"message": "name cannot be empty"
},
"metadata": {
"request_id": "b8d191a9-0f76-4867-996e-4845ae01d864"
}
}{
"error": {
"code": 404,
"message": "Some requested entity was not found"
},
"metadata": {
"request_id": "2cf7b8b2-f4c7-4db5-a617-b45324352fb7"
}
}{
"error": {
"code": 422,
"message": "Failed to deserialize the JSON body into the target type: unknown field `column`, expected one of `name`, `columns`, `filters`, `sorts`, `shared` at line 1 column 10"
},
"metadata": {
"request_id": "6b0f4c3e-6f7f-49c7-9f1e-0b6a1c2d3e4f"
}
}Returns Examples
{
"data": {
"columns": [
{
"name": "symbol"
},
{
"name": "price"
},
{
"name": "market_cap"
}
],
"created_at": "2026-04-23T13:37:04.041398Z",
"filters": [
{
"left": {
"name": "market_cap"
},
"op": {
"name": "GREATER_OR_EQUAL"
},
"right": [
{
"value": 1000000000
}
]
}
],
"id": "69fcb40a-1812-4856-b2d3-97dec805efee",
"name": "Tech Large Caps",
"sorts": [
{
"direction": "ASC",
"field": {
"name": "market_cap"
}
}
],
"updated_at": "2026-04-23T13:37:21.860106Z"
},
"metadata": {
"request_id": "71ac58a8-9b12-49b9-8301-6239febe4e56"
}
}{
"error": {
"code": 400,
"message": "name cannot be empty"
},
"metadata": {
"request_id": "b8d191a9-0f76-4867-996e-4845ae01d864"
}
}{
"error": {
"code": 404,
"message": "Some requested entity was not found"
},
"metadata": {
"request_id": "2cf7b8b2-f4c7-4db5-a617-b45324352fb7"
}
}{
"error": {
"code": 422,
"message": "Failed to deserialize the JSON body into the target type: unknown field `column`, expected one of `name`, `columns`, `filters`, `sorts`, `shared` at line 1 column 10"
},
"metadata": {
"request_id": "6b0f4c3e-6f7f-49c7-9f1e-0b6a1c2d3e4f"
}
}