---
title: "Create Notification"
method: POST
path: "/v1/notifications"
---

# Create Notification

`POST /v1/notifications`

Creates a notification in a workspace.

## Request body

- object
  - `senderId` string, required — ID of the entity sending the notification. This can be ID of client user, internal user, or a company.
  - `recipientId` string — Deprecated. Use recipientClientId, recipientCompanyId and recipientInternalUserId instead.
  - `deliveryTargets` object — The notification details for each delivery target.
    - `inProduct` object
      - `title` string, required — Title of the notification.
      - `body` string — Body of the notification.
      - `ctaParams` string, json — Key/value pairs that will be included in the search parameters when clicking on the notification’s call to action in product. This call to action is shown in the Notification Center for internal users.
    - `email` object
      - `subject` string — Subject of the email notification.
      - `header` string — Header of the email notification.
      - `body` string — Body of the email notification.
      - `title` string — Call To Action button title in the email notification.
      - `ctaParams` string, json — Key/value pairs that will be included in the search parameters when clicking on an email notification’s call to action.
      - `htmlBody` string — Html body of the email notification. Allows rich formatting for body of email sent (Used when body field is empty.) Allowlist: p, br, strong/b, em/i, ul, ol, li, a.
  - `recipientClientId` string — ID of the client receiving the notification. This required when sending a notification to a client.
  - `recipientCompanyId` string — ID of the company receiving the notification. This is required when sending a notification to a client that has more than one company.
  - `recipientInternalUserId` string — ID of the internal user receiving the notification. This is required when sending a notification to an internal user.
  - `senderCompanyId` string — The ID of the company associated with the sender of this notification. This is required when the sender is a client with more than one company.

## Response `200`

200

- object
  - `appId` string
  - `createdAt` string
  - `deliveryTargets` object
    - `inProduct` object
      - `title` string
      - `body` string
      - `isRead` boolean
      - `ctaParams` object
        - `foo` string
    - `email` object
      - `subject` string
      - `header` string
      - `body` string
      - `title` string
      - `ctaParams` object
        - `foo` string
  - `event` string
  - `id` string
  - `object` string
  - `recipientId` string
  - `recipientClientId` string
  - `recipientCompanyId` string
  - `recipientInternalUserId` string
  - `resourceId` string
  - `senderId` string
  - `senderType` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/assembly/apis/core-resources.md) · [All operations](https://skmtc.net/assembly/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/assembly/core-resources/versions/28a9e7d13a8c/schema)