Send notification to the organization (ORG)

Send notification to the organization (ORG)

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

Broadcast notifications to all users across the entire organization.

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	"ORG"

JSON body

{
  "content": {
    "title": "Update your app",
    "text": "We released a new version of the app",
    "screen":"jig"
  },
  "scope": "ORG"
}

Response

200

{
    "organizationId": "{{orgId}}",
    "region": "us-east-1",
    "notificationId": "02817dcd-175c-4d0f-8c47-f1838c8e628c",
    "scope": "ORG",
    "state": "QUEUED",
    "startAt": "2025-04-04T10:06:50.444Z",
    "content": {
        "text": "We released a new version of the app",
        "title": "Update your app",
        "screen": "jig",
        "inputs": {}
    },
    "createdAt": "2025-04-04T10:06:50.444Z",
    "createdBy": "{{userId}}",
    "updatedAt": "2025-04-04T10:06:50.444Z",
    "updatedBy": "{{userId}}"
}

400