API Reference

V1

Screener

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete Screener

v1().screener().deleteScreener(ScreenerDeleteScreenerParamsparams = ScreenerDeleteScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/saved-screeners/{screener_id}

Delete a saved screener configuration.

Deletes the screener configuration for the authenticated user.

ParametersExpand Collapse

ScreenerDeleteScreenerParams params

Optional<String> screenerId

Delete Screener

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

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.ScreenerDeleteScreenerParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        client.v1().screener().deleteScreener("550e8400-e29b-41d4-a716-446655440000");
    }
}

404 example

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "aafc54ec-939e-49a9-ab6e-bbabca005cb2"
  }
}

Returns Examples

404 example

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "aafc54ec-939e-49a9-ab6e-bbabca005cb2"
  }
}