Skip to content

Update a Post-Appointment Message Template

PATCH
/businesses/{businessId}/notifications/post-appointment-message-templates/{postAppointmentMessageTemplateId}

Update an existing post-appointment message template.

businessId
required

The ID of the Business.

string
postAppointmentMessageTemplateId
required

The ID of the Post-Appointment Message Template.

string
Post-Appointment Message Template Update Input
object
enabled

Whether this template is enabled.

boolean
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 updated Post-Appointment Message 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 after the appointment to send the message.

number
type

The type of notification (EMAIL or SMS).

string
Allowed values: EMAIL SMS
recipient

The recipient of the message.

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 recipient 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

Post-Appointment Message Template not found.

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