Trackers

Update tracker

Partial update: send only the fields to change. The tracked entity itself (entity_name/entity_type) is immutable; delete and recreate to watch a different entity. Delivery is the monitor's: change it with PATCH /v1/monitors/{id}.

patch/v1/trackers/{id}

Request

Base URL: https://api.arcmira.com
URL: https://api.arcmira.com/v1/trackers/{id}
Auth: HTTP bearer

Path parameters

idstring required

Tracker id, trk_ form.

Headers

Idempotency-Keystring

One key per intent, 1 to 255 printable ASCII characters (0x21 to 0x7E); anything else is 400 invalid_idempotency_key. Keys are scoped to the account, credential and resource family. The same key and normalized method, path and body returns the committed response with Idempotency-Replayed: true. A changed intent within the same family returns 409 idempotency_conflict. Monitor and tracker families have independent namespaces. Secret recovery is limited as described by the operation.

Request body

display_namestring

Optional label shown in alerts and the dashboard.

notify_emailboolean

Retired: a tracker alerts through its monitor's delivery (set it with PATCH /v1/monitors/{id}). Omitted or true is accepted and ignored; any other value answers 400 tracker_delivery_retired.

notify_webhookboolean

Retired: a tracker alerts through its monitor's delivery (set it with PATCH /v1/monitors/{id}). Omitted or false is accepted and ignored; any other value answers 400 tracker_delivery_retired.

notify_slackboolean

Retired: a tracker alerts through its monitor's delivery (set it with PATCH /v1/monitors/{id}). Omitted or false is accepted and ignored; any other value answers 400 tracker_delivery_retired.

webhook_urlstring nullable

Retired: a tracker alerts through its monitor's delivery (set it with PATCH /v1/monitors/{id}). Omitted or null is accepted and ignored; any other value answers 400 tracker_delivery_retired.

slack_channel_idstring nullable

Retired: a tracker alerts through its monitor's delivery (set it with PATCH /v1/monitors/{id}). Omitted or null is accepted and ignored; any other value answers 400 tracker_delivery_retired.

slack_integration_idstring nullable

Retired: a tracker alerts through its monitor's delivery (set it with PATCH /v1/monitors/{id}). Omitted or null is accepted and ignored; any other value answers 400 tracker_delivery_retired.

person_match_mode'mentions' | 'appearances' | 'both'

Person trackers only. Mentions (default) matches others talking about the person; appearances matches the person present as a speaker, host or guest; both accepts either. Non-person trackers reject this field. PATCH changes future and pending delivery eligibility, without backfill.

filtersobject

Stored filter object. personMatchMode is also accepted here for person trackers. Other filter keys are retained; do not assume they change matching.

pausedboolean

Pause or resume the tracker. Paused trackers stop producing alerts; there is no backfill for the paused window.

Response

Success

messagestring required

Human-readable confirmation.

Changes

No recorded changes to this operation across all 1 revision of this API.