---
title: "Subscribe"
method: POST
path: "/v1/notif"
tags: ["Notifications"]
---

# Subscribe

`POST /v1/notif`

Subscribe to notifications for a report/dashboard.

## Headers

- `authorization` string, nullable

## Request body

- NotifRequest — Subscribe/unsubscribe request.
  - `resource_id` string, required
  - `resource_type` string, required
  - `user_id` string, required
  - `user_email` string, email, required
  - `user_name` string, nullable
  - `notify_on` 'disabled' | 'refresh' | 'change'

## Response `200`

Successful Response

- NotifResponse — Notification subscription response.
  - `id` string, nullable
  - `user_id` string, required
  - `resource_id` string, required
  - `resource_type` string, required
  - `subscribed` boolean, required
  - `notify_on` 'disabled' | 'refresh' | 'change'

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/chonkie/apis/chonkie-api.md) · [All operations](https://skmtc.dev/chonkie/apis/chonkie-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chonkie/apis/chonkie-api/revisions/f40f036f941c?raw)