Notification APIs

Create a Notification

Purpose

To create custom push notifications for the web and mobile app.

Request URL

https://fsm.zoho.com/fsm/v1/notifications/actions/send

Request Method

POST

Scope

scope=ZohoFSM.notifications.CREATE

Mandatory Parameters

Name	Description	Type	Mandatory
title	The title for the custom notification	String	Yes
message	The content of the custom notification	String	Yes
userids	The IDs of the users to whom the notifications need to be sent	String	Yes
onclick	To take the user to a specific record. The JSON keys to be used are: record_id: Include the ID of the record you want the user to be taken to on clicking the notification. module_api: The API name of the module to which the record belongs. The possible values are Assets, Accounts, Contacts, Products, Service_Appointments, Work_Orders, Estimates, Requests To take the user to an external link. The JSON key to be used is: link_url: The URL of the external link	JSON Object

Sample Request

Copiedcurl --location --request POST 'https://fsm.zoho.com/fsm/v1/notifications/actions/send' \
-header 'Authorization: Zoho-oauthtoken 1000.26xxxxxxxxxx.xxxxxxxxxx0' \
--header 'content-type: application/json' \
--data "@newNotification.json"

Sample Input

Copied{
    "title":"Custom Notification",
    "message":"This is a custom notification !!!",
    "userids":"1439XXXX1001,1439XXXX1190",
    "onclick":{//to open a particular record
        "record_id":"1439XXXX7012",
        "module_api":"Estimates"
    }
}

Sample Success Response

Copied{"status":"success"}