Notification Templates

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Notification Templates

A notification template that can be reused in notifications or launch policies.


NOTE: To launch a template, see POST /notifications/{organizationId} .

GET /notificationTemplates/{organizationId}

Description

Return a paged set of notificationTemplates within the organization.

Return type

[collection] of [notificationTemplates]

Parameters

NameData TypeRequired?Description

credentials

string

y

Basic Authorization header.

organizationId

long

y

The ID of the organization containing the notificationTemplates.

queryValue

string

n

Filter templates by message title or category name.

pageNumber

int

y

The page of notificationTemplates to return.

GET /notificationTemplates/{organizationId}/{notificationTemplateId}

Description

Retrieve a specific notificationTemplate within an organization.

Return type

NotificationTemplate instance

Parameters

NameData TypeRequired?Description

credentials

string

y

Basic Authorization header.

organizationId

long

y

The ID of the organization containing the notificationTemplate.

notificationTemplateId

long

y

The ID of the notificationTemplate to return.

Example Response

{
  "message": "OK",
  "page": {
    "pageSize": 10,
    "start": 0,
    "data": [
      {
        "createdName": "Jeff Barras",
        "accountId": 8800387990738,
        "broadcastContacts": {
          "contactIds": [
            444206992588867
          ],
          "contactSearchType": "AllOr",
          "sequenceGroupEnabled": false,
          "defaultSeqGroupQuota": 1,
          "sequenceGroupInterval": 5
        },
        "status": "A",
        "categoryId": 444206992588858,
        "resourceBundleId": 8800387991734,
        "organizationId": 8800387991360,
        "publicMessages": {
          "networkEffectMessage": {
            "body": "look out",
            "accountId": 8800387990738,
            "organizationId": 8800387991360,
            "sourceId": 0,
            "id": 0,
            "networkEffectSetting": {
              "createdName": "Deb Hughes",
              "publishCategories": [
                {
                  "accountId": 0,
                  "resourceBundleId": 0,
                  "organizationId": 0,
                  "id": 1,
                  "name": "City/State Government",
                  "seq": 1,
                  "createdId": 0,
                  "lastModifiedId": 0
                }
              ],
              "displayLogo": false,
              "accountId": 0,
              "status": "A",
              "resourceBundleId": 233109349990401,
              "allPublishCategories": false,
              "organizationId": 8800387991360,
              "allSubscribeAddresses": false,
              "id": 8800387990496,
              "category": {
                "accountId": 0,
                "resourceBundleId": 0,
                "organizationId": 0,
                "id": 1,
                "name": "City/State Government",
                "seq": 1,
                "createdId": 0,
                "lastModifiedId": 0
              },
              "nickName": "Dev",
              "lastModifiedDate": 1486998706977,
              "lastModifiedId": 8800387989879,
              "createdId": 8800387990502,
              "allSubscribeCategories": false,
              "createdDate": 1403258037410,
              "lastModifiedName": "Jeff Barros"
            },
            "title": "ITA WARNING",
            "sent": false,
            "trainingMode": false,
            "createdDate": 1488907772131,
            "createdName": "Reece Battle",
            "status": "A",
            "resourceBundleId": 8800387991734,
            "lastModifiedDate": 1488907772131,
            "createdId": 444206992589542,
            "lastModifiedId": 444206992589542,
            "receiveOrgId": 0,
            "lastModifiedName": "Reece Battle"
          }
        },
        "type": "Standard",
        "id": 444206992589464,
        "message": {
          "accountId": 0,
          "organizationId": 0,
          "contentType": "Text",
          "id": 0,
          "title": "ITA WARNING",
          "textMessage": "Response team B is ",
          "conferenceBridgeId": 0,
          "categoryId": 444206992588858,
          "resourceBundleId": 0,
          "category": {
            "createdName": "Leslie Lemon",
            "accountId": 8800387990738,
            "status": "A",
            "resourceBundleId": 8800387991734,
            "organizationId": 8800387991360,
            "id": 444206992588858,
            "name": "test",
            "createdId": 444206992589476,
            "lastModifiedId": 444206992589476,
            "lastModifiedDate": 1437836690792,
            "createdDate": 1437836690792,
            "lastModifiedName": "Leslie Lemon"
          },
          "lastModifiedId": 0,
          "createdId": 0
        },
        "broadcastSettings": {
          "voiceMailOption": "MESSAGE_ONLY",
          "throttlDefaultAmount": 0,
          "throttle": false,
          "mobileSettings": {
            "requestComment": false,
            "requestImage": false,
            "requestLocation": false,
            "allowShare": false,
            "requireConfirm": false,
            "pushAlertEnabled": false
          },
          "requirePinForMessage": false,
          "deliveryMethodInterval": 0,
          "bookConference": false,
          "cycleInterval": 0,
          "duration": 1,
          "senderCallerInfos": [
            {
              "countryName": "United States",
              "accountId": 0,
              "countryCode": "US",
              "resourceBundleId": 0,
              "organizationId": 0,
              "id": 0,
              "callerId": "7742109934",
              "isDefault": true,
              "createdId": 0,
              "lastModifiedId": 0
            }
          ],
          "contactCycles": 1,
          "language": "en_US",
          "recipientApp": false,
          "senderEmail": "[email protected]",
          "confirm": false,
          "deliveryPathOrder": "Contact"
        },
        "category": {
          "createdName": "Jeff Barras",
          "accountId": 8800387990738,
          "status": "A",
          "resourceBundleId": 8800387991734,
          "organizationId": 8800387991360,
          "id": 444206992588858,
          "name": "ITA WARNING",
          "createdId": 444206992589476,
          "lastModifiedId": 444206992589476,
          "lastModifiedDate": 1437836690792,
          "createdDate": 1437836690792,
          "lastModifiedName": "Jeff Barras"
        },
        "priority": "Priority",
        "lastModifiedDate": 1488907772131,
        "lastModifiedId": 444206992589542,
        "createdId": 444206992589542,
        "createdDate": 1488907772131,
        "lastModifiedName": "Leanne Islip",
        "useEscalation": false
      }
    ],
    "totalCount": 1,
    "totalPageCount": 1,
    "currentPageNo": 1
  }
}

POST /notificationTemplates/{organizationId}

Description

Create a new notificationTemplate.

Return type

notificationTemplate instance

Parameters

NameData TypeRequired?Description

credentials

string

y

Basic Authorization header.

organizationId

long

y

The ID of the organization from which to initiate the notificationTemplate.

notificationTemplate

BroadcastTemplateWrapper

y

The NotificationTemplate object to create.

Example Request

These are the REQUIRED fields for a new Notification Template. The output is the notificationTemplateId.

{
  "priority": "NonPriority",
  "message": {
    "title": "Notification from API_standard",
    "textMessage": "Notification from API"
  },
  "type": "Standard",
  "broadcastContacts": {
    "contactIds": [
      4402341479497
    ]
  },
  "broadcastSettings": null
}

Example Response

{
  "message": "OK",
  "id": "notificationId"
}

PUT /notificationTemplates/{organizationId}/{notificationTemplateId}

Description

Return a paged set of notificationTemplates within the organization.

Return type

notificationTemplate instance

Parameters

NameData TypeRequired?Description

credentials

string

y

Basic Authorization header.

organizationId

long

y

The ID of the organization containing the notificationTemplates.

queryValue

string

n

Filter templates by message title or category name.

pageNumber

int

y

The page number of notificationTemplates to return.

DELETE /notificationTemplates/{organizationId}/{notificationTemplateId}

Description

Delete the specified notificationTemplate from the organization.

Return type

notificationTemplate instance

Parameters

NameData TypeRequired?Description

credentials

string

y

Basic Authorization header.

organizationId

long

y

The ID of the organization from which to initiate the notificationTemplate.

notificationTemplate

BroadcastTemplateWrapper

y

The NotificationTemplate object to create.