---
title: "Hide prospects"
method: POST
path: "/v1/finder/prospects/hide"
tags: ["RecruitAffiliates.ai"]
---

# Hide prospects

`POST /v1/finder/prospects/hide`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/prospects/hide`
- Auth: HTTP bearer

Not a fit. Soft, never a delete: the rows move to the `hidden` view and `restore` brings them back.

**Scope:** `finder:write`

## Request body

- FinderProspectHide
  - `ids` string[], required: 1 to 100 prospect ids
  - `reason` 'sells_own_product' | 'wrong_audience' | 'too_small' | 'too_big' | 'not_my_topic' | 'other', required: Why they're not a fit. Some reasons also tune the brand's settings; `effects` in the answer says which.

## Response `200`

What was hidden

- FinderHideResult
  - `object` 'finder_hide_result', required
  - `hidden` string[], required
  - `effects` object[], required: What the reason changed in the brand's settings, if anything

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)