# Yoobic Notifications API

**Canonical:** https://apis.io/apis/yoobic/yoobic-notifications-api/  
**Provider:** Yoobic — https://apis.io/providers/yoobic/  
**Base URL:** https://api.yoobic.com/public/api  
**Documentation:** https://docs.yoobic.com/api.html

Yoobic Notifications API is one of 41 APIs that [Yoobic](https://apis.io/providers/yoobic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

<a id="group-notifications"></a> Notifications provide information about the internal notifications sent to users in the application. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`notification_id` | string | x | x | | Unique id of the notification | |`title` | string | x | | | The title of notification | |`mode` | string | | | | The way in which the notification is sent. Possible values (`push`, `email`, `all`) | |`body` | string | x | | | Notification body | |`user_ids` | array | x | | | Target user ids to send the notification | |`group_ids` | array | | | | Send notification to all users in group_ids, but not to users from imbricated groups | |`badge_type` | string | | x | | Specifies which badge in the Operations or Boost app should be incremented for recipients of this notification | |`sender_id` | string | | x | | Unique id of the user triggering the notification | |`push_recipients` | number | | x | | Number of recipients | |`entity_type` | string | | | | The entity's type for which the notification was created. Possible values (`missions`, `news`, `campaigns`) | |`entity_id` | string | | | | The unique id of the entity | |`created_date` | date | | x | | Creation date | |`updated_date` | date | | x | x | Last update date | **Important**: - `entity_type` and `entity_id` are used to redirect the user once he/she click on the notification. - `group_ids` is used only when creating the notification. Therefore, it won't be provided on the response. Instead, all the recipients. - There is a limit of 50k notifications. If you need to send more than this, you can split the recipients in separate requests targetting different groups.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-notifications-api-openapi.yml
- **Documentation** — https://docs.yoobic.com/api.html
- **APIReference** — https://docs.yoobic.com/api.html
- **Postman** — https://assets.yoobic.com/raw/upload/v1767016464/3c85c240-dd03-4981-9814-bc6e5e861fa0.zip
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/errors/yoobic-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conventions/yoobic-conventions.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/changelog/yoobic-changelog.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/lifecycle/yoobic-lifecycle.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conformance/yoobic-conformance.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/sandbox/yoobic-sandbox.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/asyncapi/yoobic-webhooks.yml

## Other Yoobic APIs (12)

- [Yoobic Answers API](https://apis.io/apis/yoobic/yoobic-answers-api/)
- [Yoobic Badges API](https://apis.io/apis/yoobic/yoobic-badges-api/)
- [Yoobic Bot Messages API](https://apis.io/apis/yoobic/yoobic-bot-messages-api/)
- [Yoobic Bots API](https://apis.io/apis/yoobic/yoobic-bots-api/)
- [Yoobic Business KPIs data - salesdata API](https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/)
- [Yoobic Campaigns API](https://apis.io/apis/yoobic/yoobic-campaigns-api/)
- [Yoobic Catalogs API](https://apis.io/apis/yoobic/yoobic-catalogs-api/)
- [Yoobic Chats API](https://apis.io/apis/yoobic/yoobic-chats-api/)
- [Yoobic Comments API](https://apis.io/apis/yoobic/yoobic-comments-api/)
- [Yoobic Communities API](https://apis.io/apis/yoobic/yoobic-communities-api/)
- [Yoobic Community Posts API](https://apis.io/apis/yoobic/yoobic-community-posts-api/)
- [Yoobic Competencies API](https://apis.io/apis/yoobic/yoobic-competencies-api/)

## Tags

Notification

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yoobic/yoobic-notifications-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yoobic/.