Pular para o conteúdo
Healthing CRM

Create Notification

POST
/api/v1/notifications

Create a new notification.

Requires admin or owner role to create notifications for other users. Users can only create notifications for themselves.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Request Body required

Seção intitulada “Request Body required ”
NotificationCreate

Create notification schema.

object
type
string
Allowed values: info success warning error message
icon
string
Allowed values: bell mail calendar users building check alert
title
required
Title
string
>= 1 characters <= 500 characters
message
required
Message
string
>= 1 characters
link
Any of:
string
<= 1000 characters
entity_type
Any of:
string
<= 50 characters
entity_id
Any of:
integer
user_id
required
User Id

User ID to notify

integer

Responses

Seção intitulada “ Responses ”

201

Seção intitulada “201 ”

Successful Response

NotificationResponse

Notification response schema.

object
type
string
Allowed values: info success warning error message
icon
string
Allowed values: bell mail calendar users building check alert
title
required
Title
string
>= 1 characters <= 500 characters
message
required
Message
string
>= 1 characters
link
Any of:
string
<= 1000 characters
entity_type
Any of:
string
<= 50 characters
entity_id
Any of:
integer
id
required
Id
integer
user_id
required
User Id
integer
is_read
required
Is Read
boolean
read_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string