Retrieve a Reminder Template

GET

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

• production

Retrieve a reminder template by ID.

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

reminderTemplateId

required

The ID of the Reminder Template.

string

Responses

200

A 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

404

Reminder Template not found.

object

error

object

code

number

Example

404

title

string

Example

Not Found