Skip to content

Create a Reminder Template

POST
/businesses/{businessId}/notifications/reminder-templates

Create a new reminder template.

businessId
required

The ID of the Business.

string
Reminder Template Create Input
object
minutes
required

The number of minutes before the appointment to send the reminder.

integer
>= 1 <= 525600
type
required

The type of notification (EMAIL or SMS).

string
Allowed values: EMAIL SMS
resourceType
required

The resource type this reminder applies to.

string
Allowed values: PATIENT STAFF
serviceIds

The IDs of the services this template applies to. Defaults to an empty array (all services).

Array<string>
messageTemplate

Custom message template override.

object
type
required

The message template type.

string
Allowed values: email sms
subject
required

The email subject line.

string
content
required

The message content with template variables.

string

The created Reminder Template.

object
data
object
id

Unique identifier across the platform.

string format: uuid
createdAt

Time when the resource was created (ISO 8601 format).

string format: date-time
updatedAt

Time when the resource was last updated (ISO 8601 format).

string format: date-time
businessId

The ID of the business this template belongs to.

string format: uuid
serviceIds

The IDs of the services this template applies to. An empty array means all services.

Array<string>
minutes

The number of minutes before the appointment to send the reminder.

number
type

The type of notification (EMAIL or SMS).

string
Allowed values: EMAIL SMS
resourceType

The resource type this reminder applies to.

string
enabled

Whether this template is enabled.

boolean
messageTemplate

Custom message template override. Null if using the default.

object
id

The unique identifier for the message template.

string
type

The message template type.

string
Allowed values: email sms
subject

The email subject line.

string
content

The message content with template variables.

string
defaultTemplate

The default message template for this type and resource type combination.

object
id

The unique identifier for the message template.

string
type

The message template type.

string
Allowed values: email sms
subject

The email subject line.

string
content

The message content with template variables.

string

Invalid input.

object
error
object
code
number
Example
404
title
string
Example
Not Found