Reminders

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!
}

Reminder fields

Field nameValue typeNon nullDescription
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
}

ReminderStatus valid values

Valid valueDescription
NEW
Lorem ipsum
READY
Lorem ipsum
EXECUTED
Lorem ipsum
CANCELED
Lorem ipsum

ReminderChannel

enum ReminderChannel {
	EMAIL
	SMS
}

ReminderChannel valid values

Valid valueDescription
EMAIL
Lorem ipsum
SMS
Lorem ipsum

Queries

reminder

Returns a Reminder resource by ID.

reminder(
	reminderId: ID!
): Reminder

reminder arguments

Field nameValue typeRequiredDescription
reminderId
ID
true
A globally-unique identifier.
🔑

Minimal role required: USER

Mutations

reminderCreate

reminderCreate(
	bookingId: ID!
	dateTime: DateTime!
): Reminder

reminderCreate arguments

Field nameValue typeRequiredDescription
bookingId
ID
true
A globally-unique identifier.
dateTime
DateTime
true
🔑

Minimal role required: USER

reminderCancel

Cancels a reminder.

reminderCancel(
	reminderId: ID!
): Reminder

reminderCancel arguments

Field nameValue typeRequiredDescription
reminderId
ID
true
A globally-unique identifier.
🔑

Minimal role required: USER

reminderDelete

Removes a reminder.

reminderDelete(
	reminderId: ID!
): String

reminderDelete arguments

Field nameValue typeRequiredDescription
reminderId
ID
true
A globally-unique identifier.
🔑

Minimal role required: ADMIN / APIADMIN