API Reference

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

Enums

ReminderStatus

enum ReminderStatus {
	NEW
	READY
	EXECUTED
	CANCELED
}

ReminderStatus valid values

ReminderChannel

enum ReminderChannel {
	EMAIL
	SMS
}

ReminderChannel valid values

Queries

reminder

Returns a Reminder resource by ID.

reminder(
	reminderId: ID!
): Reminder

reminder arguments

<aside> 🔑 Minimal role required: USER

</aside>

Mutations

reminderCreate

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

reminderCreate arguments

<aside> 🔑 Minimal role required: USER

</aside>

reminderCancel

Cancels a reminder.

reminderCancel(
	reminderId: ID!
): Reminder

reminderCancel arguments

<aside> 🔑 Minimal role required: USER

</aside>

reminderDelete

Removes a reminder.

reminderDelete(
	reminderId: ID!
): String

reminderDelete arguments

<aside> 🔑 Minimal role required: ADMIN / APIADMIN

</aside>