API Reference

Create a NotificationTemplate

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

Overview

Create a new notification template. .**.

Available for Directory and App tokens

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

Unique identifier name for the notification

title
array of objects
required

List of localized strings. Each item is a locale-value pair: locale is a locale (from enum), value is a string. Each language can appear only once.

title*
description
array of objects
required

List of localized strings. Each item is a locale-value pair: locale is a locale (from enum), value is a string. Each language can appear only once.

description*
string
enum
required

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

boolean
required

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

content
object
required

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 2 months ago

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 2 months ago