---
title: "Create notifications"
method: POST
path: "/inbox-notifications"
tags: ["Inbox Notifications"]
---

# Create notifications

`POST /inbox-notifications`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/inbox-notifications`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

## Request body

- CreateInboxNotification
  - `audience_type` 'all_users' | 'workspace' | 'user', required: Define the audience type for the inbox-notification (all_users, workspace, user)
  - `audience_roles` 'admin' | 'owner' | 'creator' | 'member' | 'guest': Specify with roles users must have in order to create inbox-notifications for them, only needed if audience_type is workspace
  - `user_ids` string: List of user_ids to create inbox-notifications for
  - `workspace_id` string: Specific Workspace to create inbox-notifications for
  - `action_url` string, required: The endpoint for inbox notification action
  - `message` string, required: Message that will be visible to the users
  - `category` 'workspace' | 'mentions' | 'carbonVoice' | 'security' | 'general': Category to group the inbox-notifications, defaults to General
  - `type` 'general.new.update' | 'general.new.article', required: Type of Notification
  - `send_push_notification` boolean: Send push notification to users
  - `push_title` string: Push title
  - `push_subtitle` string: Push subtitle

## Other responses

- `403`

---

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