/watchlist/candidates/{id}/promoteAdd a candidate to the watchlist
Confirms a discovered case candidate as a tracked case.
Overview
Confirms a discovered case candidate as a tracked case. The case becomes ACTIVE and starts being monitored; if it is already tracked, the existing record is linked instead of duplicated. A candidate can be confirmed when it came from a historical search (discoveryMode HISTORICAL), or from ongoing monitoring (discoveryMode ONGOING) once CasePrimus has approved it (status APPROVED). Available on accounts where your own team reviews new cases. Where the CasePrimus team reviews new cases for you, they confirm candidates instead.
X-CasePrimus-Api-Key header. See Authentication for how to create a key, and Rate limits & errors for how requests are counted.Parameters
| Name | In | Description |
|---|---|---|
idstring Required | path | The id returned when the resource was created. |
Example request
Replace CASEPRIMUS_API_KEY with your key.
BASE="https://api.caseprimus.ai/api/caseprimus/v1" curl -X POST "$BASE/watchlist/candidates/CANDIDATE_ID/promote" \ -H "X-CasePrimus-Api-Key: $CASEPRIMUS_API_KEY"
const BASE = "https://api.caseprimus.ai/api/caseprimus/v1"; const res = await fetch(BASE + "/watchlist/candidates/CANDIDATE_ID/promote", { method: "POST", headers: { "X-CasePrimus-Api-Key": process.env.CASEPRIMUS_API_KEY, }, }); const data = await res.json();
import os import requests BASE = "https://api.caseprimus.ai/api/caseprimus/v1" res = requests.request( "POST", BASE + "/watchlist/candidates/CANDIDATE_ID/promote", headers={"X-CasePrimus-Api-Key": os.environ["CASEPRIMUS_API_KEY"]}, ) data = res.json()
Responses
| Field | Description |
|---|---|
caseIdstring | |
linkedExistingboolean | true if this case was already tracked (possibly against a different company) and this entity was just linked to it, rather than a new case being created. |
{
"caseId": "CPWLC0exampledemo0002",
"linkedExisting": false
}{
"httpStatusCode": 400,
"code": 60411,
"message": "This candidate has not been approved yet",
"appError": true
}{
"httpStatusCode": 400,
"code": 60412,
"message": "This candidate has already been added to the watchlist",
"appError": true
}{
"httpStatusCode": 400,
"code": 60412,
"message": "This candidate has already been added to the watchlist",
"appError": true
}{
"httpStatusCode": 403,
"code": 60413,
"message": "Adding this candidate to the watchlist is not allowed for your account's monitoring pack",
"appError": true
}Error responses share one shape, listed on Rate limits & errors.