Create a monitor for a business

POST

https://api.middesk.com/v1/businesses/:business_id/monitor

POST

/v1/businesses/:business_id/monitor

1 curl -X POST https://api.middesk.com/v1/businesses/business_id/monitor \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "event_types": [
6     "bankruptcy.created",
7     "registration.changed",
8     "watchlist.hit",
9     "lien.created"
10   ]
11 }'

Try it

201Monitor request

1 {
2   "object": "monitor",
3   "id": "c9d0e1f2-a3b4-5678-2345-6789abcdef01",
4   "created_at": "2025-01-07T12:00:00.000Z",
5   "event_types": [
6     {
7       "type": "bankruptcy.created",
8       "enabled_at": "2025-01-07T12:00:00.000Z",
9       "status": "active"
10     },
11     {
12       "type": "registration.changed",
13       "enabled_at": "2025-01-07T12:00:00.000Z",
14       "status": "active"
15     },
16     {
17       "type": "watchlist.hit",
18       "status": "unavailable"
19     },
20     {
21       "type": "lien.created",
22       "status": "pending"
23     }
24   ]
25 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

business_idstringRequired

Business ID

Request

This endpoint expects an object.

event_typeslist of stringsRequired

Array of event types to monitor, or [”*”] for all types

Response

monitor created