Send notification to users (USR)

Send notification to users (USR)

POST {{baseURL}}/tool/organizations/{{orgId}}/notifications

Target specific users to send a notification to.

Headers

Name	Value
Authorization	Bearer <token> Bearer Token - format: BEARER XXXXXXXXXXXXXX

Body

Configure the following properties in the JSON body:

Name	Type	Description
title	string	Title of the notification.
text	string	Notification message.
scope	string	"USR" for individual users.
emails	string	List users' email addresses using a comma-delimited format for multiple addresses.

JSON body

{
  "content": {
    "title": "Approved",
    "text": "Your overtime for this month has been approved",
    "screen":"jig"
    
  },
  "scope": "USR",
  "emails": [
    "[email protected]"
  ]
}

Response

200

{
    "organizationId": "{{orgId}}",
    "region": "us-east-1",
    "notificationId": "fdb9af93-100a-4b1b-8135-972bcfe4a5df",
    "scope": "USR",
    "emails": [
        "[email protected]"
    ],
    "state": "QUEUED",
    "startAt": "2025-04-04T08:18:54.435Z",
    "content": {
        "text": "Your overtime for this month has been approved",
        "title": "Approved",
        "screen": "jig",
        "inputs": {}
    },
    "createdAt": "2025-04-04T08:18:54.435Z",
    "createdBy": "{{userId}}",
    "updatedAt": "2025-04-04T08:18:54.435Z",
    "updatedBy": "{{userid}}"

400