API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
Reminders overview
Reminders are used to communicate with the client before the service is due. They are implemented via SMS and email.
Object types
Reminder
type Reminder {
projectId: ID!
serviceId: ID!
bookingId: ID!
reminderId: ID!
status: ReminderStatus!
channels: [ReminderChannel]!
dateTime: DateTime!
createdAt: DateTime!
updatedAt: DateTime!
}| Field name | Value type | Non null | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
serviceId | ID | true | A globally-unique identifier. |
bookingId | ID | true | A globally-unique identifier. |
reminderId | ID | true | A globally-unique identifier. |
status | ReminderStatus | true | |
channels | [ReminderChannel] | true | |
dateTime | DateTime | true | |
createdAt | DateTime | true | The date and time when a reminder was created. |
updatedAt | DateTime | true | The date and time when a reminder was updated. |
Enums
ReminderStatus
enum ReminderStatus {
NEW
READY
EXECUTED
CANCELED
}| Valid value | Description |
|---|---|
NEW | Lorem ipsum |
READY | Lorem ipsum |
EXECUTED | Lorem ipsum |
CANCELED | Lorem ipsum |
ReminderChannel
enum ReminderChannel {
EMAIL
SMS
}Queries
reminder
Returns a Reminder resource by ID.
reminder(
reminderId: ID!
): Reminder| Field name | Value type | Required | Description |
|---|---|---|---|
reminderId | ID | true | A globally-unique identifier. |
Minimal role required:
USERMutations
reminderCreate
reminderCreate(
bookingId: ID!
dateTime: DateTime!
): Reminder| Field name | Value type | Required | Description |
|---|---|---|---|
bookingId | ID | true | A globally-unique identifier. |
dateTime | DateTime | true |
Minimal role required:
USERreminderCancel
Cancels a reminder.
reminderCancel(
reminderId: ID!
): Reminder| Field name | Value type | Required | Description |
|---|---|---|---|
reminderId | ID | true | A globally-unique identifier. |
Minimal role required:
USERreminderDelete
Removes a reminder.
reminderDelete(
reminderId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
reminderId | ID | true | A globally-unique identifier. |
Minimal role required:
ADMIN / APIADMIN