Retrieve a Reminder Template

GET

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

const url = 'https://api.upvio.com/v1/businesses/example/notifications/reminder-templates/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.upvio.com/v1/businesses/example/notifications/reminder-templates/example \
  --header 'Authorization: Bearer <token>'

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.

application/json

object

data

object

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

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

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

The reminder template ID is malformed.

application/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": "Invalid platformId format."
  }
}

403

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

application/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

The reminder template does not exist.

application/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": "NotFoundError",
    "title": "Reminder Template not found"
  }
}