PUT/watchlist/entities/{id}

Update a watchlist entity

Updates the details of a watchlist entity.

Overview

Updates the details of a watchlist entity. name and entityType are required. Send every optional detail you want to keep: optional fields you leave out, such as fatherName, birthDate, location, registrationNumber and monitoredCourts, are cleared. Requires watchlist.write.

Auth API keyPermission watchlist.writeContent-Type application/json

Send your API key in the 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
`id` string Required	path	The id returned when the resource was created.

Request body

Field	Description
`name` string Required	2 to 255 characters
`entityType` enum Required	`PERSONBUSINESS`
`fatherName` string or null Optional	up to 256 characters
`birthDate` string or null Optional
`location` string or null Optional	up to 4192 characters
`registrationNumber` string or null Optional	up to 50 characters
`monitoredCourts` array of enum Optional	`ALLDCSCHCCCNCLTNCLATGSTATDRTDRATCESTAT`
`status` enum Optional	`ACTIVEPAUSEDARCHIVED`

Body: Success

{
  "name": "Acme Traders Pvt Ltd",
  "entityType": "BUSINESS",
  "location": "Bengaluru",
  "Karnataka": null
}

Example request

Replace CASEPRIMUS_API_KEY with your key.

Request

BASE="https://api.caseprimus.ai/api/caseprimus/v1"

curl -X PUT "$BASE/watchlist/entities/ENTITY_ID" \
  -H "X-CasePrimus-Api-Key: $CASEPRIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Traders Pvt Ltd",
    "entityType": "BUSINESS",
    "location": "Bengaluru",
    "Karnataka": null
  }'

const BASE = "https://api.caseprimus.ai/api/caseprimus/v1";

const res = await fetch(BASE + "/watchlist/entities/ENTITY_ID", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "X-CasePrimus-Api-Key": process.env.CASEPRIMUS_API_KEY,
  },
  body: JSON.stringify({
    "name": "Acme Traders Pvt Ltd",
    "entityType": "BUSINESS",
    "location": "Bengaluru",
    "Karnataka": null
  }),
});

const data = await res.json();

import os
import requests

BASE = "https://api.caseprimus.ai/api/caseprimus/v1"

res = requests.request(
    "PUT",
    BASE + "/watchlist/entities/ENTITY_ID",
    headers={"X-CasePrimus-Api-Key": os.environ["CASEPRIMUS_API_KEY"]},
    json={
        "name": "Acme Traders Pvt Ltd",
        "entityType": "BUSINESS",
        "location": "Bengaluru",
        "Karnataka": None,
    },
)

data = res.json()

Responses

200Entity updated.

Response 200

{}

400Entity does not exist, or malformed input.

Response 400

{
  "httpStatusCode": 400,
  "code": 60400,
  "message": "Watchlist entity does not exist",
  "appError": true
}

403This entity has not been shared with you.

Error responses share one shape, listed on Rate limits & errors.