This document contains the API details to send notifications to users on WhatsApp. You can integrate these APIs with your business system/CRM to send notifications based on your business logic. If you are directly reading this, please first refer to Notification Getting Started.

Important links:

  1. API Introduction: Use this to understand the request/response structure, authentication, status/error codes, test API, etc.
  2. Postman Collection: This postman collection contains all the APIs.

Send Notification API

This API can be used to send a notification to any particular user. Apart from sending a notification, you can also update the user's profile.


Method: POST

    Authorization: <access_token>
    Content-Type: application/json

        "accountId": "<account_id>",
        "templateId": "<template_id>",
        "postSessionParams": [
        "customerData": {
            "<property_title>": "<value>"

Request Parameters
userPhoneNumberYesStringThis is the WhatsApp number of the user you want to send a notification. Please make sure this number is with country code eg. +919626262626
accountIdYesStringThis is the business WhatsApp account id. You can find this from the platform Nurture>API.
templateIdYesStringThis is the id of the template which you want to send to your user. You can find this from the platform Nurture>API.
postSessionParamsYesArray of StringIf the template contains the dynamic parameters, then you have to pass the parameters in this. This is an ordered list means the params in this array should appear in the same order of the notification template. Also, if you skip this while sending the notification, the value will be picked from the user's profile on
customerDataOptionalNested ObjectYou can use this to also update the customer properties. You can pass any property you want to update. 

<property_title>YesStringThe name of the property you want to update.
<value>YesString/NumberThe value you want to update the property with.


  "status": "success"