Update Monitor

Update a monitor’s settings.

PATCH /api/agent/monitors/{id}

Update Monitor

cURL

curl --request PATCH \
  --url https://encrata.com/api/agent/monitors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "frequency": "<string>",
  "change_detection": "<string>",
  "status": "<string>",
  "tracked_fields": "<string>"
}
'

Authentication

Requires an API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Path parameters

id · string · required

The monitor’s unique identifier (UUID).

Request

All fields are optional — only include the fields you want to update.

name · string

Updated display name.

frequency · string

Updated run frequency: monthly or quarterly.

change_detection · string

Updated detection mode: diff_only or full_refresh.

status · string

Pause or resume: active or paused.

tracked_fields · string

JSON-encoded array of field names to track. Empty array "[]" tracks all fields.

Available fields: first_name, last_name, company, job_role, city, country, bio, industry, education, validity

Example request

curl -X PATCH https://encrata.com/api/monitors/a1b2c3d4-... \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "name": "Updated name",
    "frequency": "quarterly",
    "tracked_fields": "[\"company\",\"job_role\"]"
  }'

Response

Returns the updated monitor object.