Add a new MassUserNotification

POST /api/notification/mass_notification

Session token Jwt token internal Login config

Query parameters

iw-build-id string

build id of the client
iw-package-id string

package id of the client

application/json

Body Required

data object
Hide data attributes Show data attributes object
- send_push boolean
- send_mail boolean
- send_letter boolean
- reference_class_name string
- reference_ids array[string]
- text string | null
- long_text string | null
- html_text string
- attachments array[object]
- template object
- save_as_attachment boolean
- check_for_duplicates boolean

Responses

200 application/json

Add a new MassUserNotification
Hide response attributes Show response attributes object
- id integer
- processed boolean
- send_push boolean
- send_mail boolean
- send_letter boolean
- reference_class_name string
- reference_ids array[string]
- text string | null
- long_text string | null
- html_text string
- attachments array[object]
  
  Hide attachments attributes Show attachments attributes object
  
  id integer
  
  filename string
  
  filesize string
  
  mimetype string
  
  createdbyusername string
  
  created string(date-time)
  
  googleid string
  
  googledownloadlink string
  
  scope string
- template object
  
  Hide template attributes Show template attributes object
  
  id string
  
  name string
  
  tag string
  
  mass_message boolean
  
  default_store_as_pdf boolean
  
  security_scope string
  
  security_user_access_type integer
  
  param1 string
  
  param2 string
  
  param3 string
  
  param4 string
  
  param5 string
  
  param6 string
  
  param7 string
  
  param8 string
  
  param9 string
  
  param10 string
  
  default_value_param1 string
  
  default_value_param2 string
  
  default_value_param3 string
  
  default_value_param4 string
  
  default_value_param5 string
  
  default_value_param6 string
  
  default_value_param7 string
  
  default_value_param8 string
  
  default_value_param9 string
  
  default_value_param10 string
  
  deleted boolean
  
  created string(date-time)
  
  updated string(date-time)
- save_as_attachment boolean
- check_for_duplicates boolean
- created string(date-time)
- updated string(date-time)

POST /api/notification/mass_notification

curl \
 --request POST 'https://replace-with-own-host.iw-erp.de/api/notification/mass_notification' \
 --header "x-session-token: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"data":{"send_push":true,"send_mail":true,"send_letter":true,"reference_class_name":"string","reference_ids":["string"],"text":"string","long_text":"string","html_text":"string","attachments":[{}],"template":{},"save_as_attachment":true,"check_for_duplicates":true}}'

Request examples

{
  "data": {
    "send_push": true,
    "send_mail": true,
    "send_letter": true,
    "reference_class_name": "string",
    "reference_ids": [
      "string"
    ],
    "text": "string",
    "long_text": "string",
    "html_text": "string",
    "attachments": [
      {}
    ],
    "template": {},
    "save_as_attachment": true,
    "check_for_duplicates": true
  }
}

Response examples (200)

{
  "id": 42,
  "processed": true,
  "send_push": true,
  "send_mail": true,
  "send_letter": true,
  "reference_class_name": "string",
  "reference_ids": [
    "string"
  ],
  "text": "string",
  "long_text": "string",
  "html_text": "string",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "createdbyusername": "string",
      "created": "2025-05-04T09:42:00Z",
      "googleid": "string",
      "googledownloadlink": "string",
      "scope": "string"
    }
  ],
  "template": {
    "id": "string",
    "name": "string",
    "tag": "string",
    "mass_message": true,
    "default_store_as_pdf": true,
    "security_scope": "string",
    "security_user_access_type": 42,
    "param1": "string",
    "param2": "string",
    "param3": "string",
    "param4": "string",
    "param5": "string",
    "param6": "string",
    "param7": "string",
    "param8": "string",
    "param9": "string",
    "param10": "string",
    "default_value_param1": "string",
    "default_value_param2": "string",
    "default_value_param3": "string",
    "default_value_param4": "string",
    "default_value_param5": "string",
    "default_value_param6": "string",
    "default_value_param7": "string",
    "default_value_param8": "string",
    "default_value_param9": "string",
    "default_value_param10": "string",
    "deleted": true,
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z"
  },
  "save_as_attachment": true,
  "check_for_duplicates": true,
  "created": "2025-05-04T09:42:00Z",
  "updated": "2025-05-04T09:42:00Z"
}