API Reference

Update a NotificationTemplate

put
https://api.vcita.biz/v3/communication/notification_templates/

Overview

Update an existing notification template. .**.

Available for Directory and App tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the NotificationTemplate

Body Params
title
array of objects, unique

The display name of the notification template that appears in the staff portal notification settings. This is what users see when browsing available notification options (e.g., "Payment Received Notification"). Should contain at least one English locale entry when creating a template.

title
description
array of objects, unique

A brief explanation that appears in the staff portal notification settings to help them understand what this notification is for and when it will be triggered. Should contain at least one English locale entry when creating a template.

description
string
enum

The functional category this notification belongs to (e.g., "payments", "booking", "documents").

boolean

Boolean flag that determines whether staff members can customize or modify this notification template through the staff portal.

content
object

Notification content for 'email', 'staff_portal', and/or 'sms'. Not all content sections are required - only the channels that are relevant to the notification need to be populated.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?