Skip to content
Upvio Developer Docs

Create a Reminder Template

POST
/businesses/{businessId}/notifications/reminder-templates
curl --request POST \
  --url https://api.upvio.com/v1/businesses/example/notifications/reminder-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "minutes": 1, "type": "EMAIL", "resourceType": "PATIENT", "serviceIds": [ "example" ], "messageTemplate": { "type": "email", "subject": "example", "content": "example" } }'

Create a new reminder template.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
businessId
required

The ID of the Business.

string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
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

Responses

Section titled “Responses”

201

Section titled “201”

The created Reminder Template.

Media typeapplication/json
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

Example 

{
  "data": {
    "type": "EMAIL",
    "messageTemplate": {
      "type": "email"
    },
    "defaultTemplate": {
      "type": "email"
    }
  }
}

400

Section titled “400”

The template data is invalid. The title lists each validation issue, prefixed with the field it applies to.

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: BadRequestError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "minutes: Too small: expected number to be >=1"
  }
}

403

Section titled “403”

The API key is missing or invalid, or the Business cannot be accessed with it.

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

Section titled “404”

The Business does not exist.

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: NotFoundError BusinessNotFoundError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 404,
    "type": "BusinessNotFoundError",
    "title": "Business not found"
  }
}