Create Portfolio Notification Policy

post

https://api.baselayer.com/portfolio/notification_policies

Create a notification policy for the portfolio.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request model for creating a notification policy.

type

string

required

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

name

string

required

The name of the notification policy.

enabled

boolean

Defaults to true

Whether the notification policy should be enabled.

cadence

string

enum

required

The notification cadence (daily, weekly, monthly, yearly).

Allowed:

attributes

array of objects

Defaults to []

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

Attributes

recipients

array of strings

Defaults to []

List of email recipients for email notification policies.

Recipients

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.baselayer.v1+json

201Response