v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Portfolio Monitoring

Update Notification Policy

Update a notification policy by ID.

put/notification_policies/{notification_policy_id}

notification_policy_idstring uuid required

namestring nullable

The name of the notification policy.

enabledboolean nullable

Whether the notification policy should be enabled.

The cadence of monitoring.

attributesV1NotifiableAttributes[] nullable

List of attributes to notify on (officers, alternative_names).

recipientsstring[] nullable

List of email recipients for email notification policies.

{
  "attributes": [
    "officers"
  ],
  "recipients": [
    "user@example.com",
    "admin@example.com"
  ]
}

idstring uuid required

The unique identifier of the notification policy.

typestring required

The type of notification policy (email, slack, webhook).

namestring required

The name of the notification policy.

group_idstring uuid nullable

The unique identifier of the portfolio group (if applicable).

item_idstring uuid nullable

The unique identifier of the portfolio item (if applicable).

enabledboolean required

Whether the notification policy is enabled.

The cadence of monitoring.

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.

attributesV1NotifiableAttributes[]

List of attributes to notify on (officers, alternative_names).

recipientsstring[]

List of email recipients for email notification policies.

created_atstring date-time required

When the notification policy was created.

updated_atstring date-time nullable

When the notification policy was last updated.

{
  "type": "email",
  "attributes": [
    "officers"
  ],
  "recipients": [
    "user@example.com",
    "admin@example.com"
  ]
}