Get organization notification template V2

Get organization’s default notification schedule template

POST /api/org/getOrgNotificationTemplateV2

Get organization notification template V2

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/org/getOrgNotificationTemplateV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "notificationSettings": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "smsPhoneNumbers": [
      "<string>"
    ],
    "summaryEmailEnabled": true,
    "timeFrames": [
      {
        "days": [],
        "interval": {
          "dayOfWeek": 123,
          "minuteOfDayStartInclusive": 123,
          "minuteOfDayStopExclusive": 123
        },
        "mediums": [],
        "rows": [
          {
            "activities": [],
            "devices": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ],
            "diagnostics": [],
            "locationOnly": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "locationOnlyActivities": [],
            "locationOnlyDiagnostics": [],
            "locations": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "promptUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ]
          }
        ]
      }
    ],
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting organization notification template.

Response

200 - application/json

OK

Response object containing organization notification template V2.

error · boolean | null

errorMsg · string | null

notificationSettings · object

List of user notification settings (V4)

Show child attributes

warningMsg · string | null