Sign in
Portfolio Monitoring

Update Portfolio Monitoring Policy

Update the monitoring policy for the portfolio.

put/portfolio/monitoring_policy

Request body

enabledboolean

Whether the monitoring policy should be enabled.

cadence'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'biannually' | 'annually' required

The cadence of monitoring.

attributesV1MonitorableAttributes[]

List of attributes to monitor (liens, litigations, bankruptcies, etc.).

lien_monitoring_scope'domestic' | 'registered'

The scope of states that will be monitored for liens.

When the scope is "domestic", the policy will monitor liens for the state of the domestic registration. When the scope is "registered", the policy will monitor liens for the states of all registrations.

Example request

{
  "attributes": [
    "liens",
    "litigations"
  ]
}

Response

Response

cadence'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'biannually' | 'annually' required

The cadence of monitoring.

attributesV1MonitorableAttributes[]

The attributes to monitor.

lien_monitoring_scope'domestic' | 'registered' required

The scope of states that will be monitored for liens.

When the scope is "domestic", the policy will monitor liens for the state of the domestic registration. When the scope is "registered", the policy will monitor liens for the states of all registrations.

enabledboolean required

Whether the monitoring policy is enabled.

last_run_atstring date-time nullable

When the notification policy was last executed.

next_run_onstring date nullable

When the notification policy is scheduled to run next.

inherited_from'portfolio' | 'group'

Changes

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