Reminders

The Reminder object represents a scheduled alert for a user in the EstatePrime system. Reminders can be linked to a contact or other system records and will notify the assigned user at the specified date and time.

Object

The Reminder object represents an individual reminder record. Below are the fields included in a Reminder object:

Example

{
  "id": 14,
  "user_id": 3,
  "date_created": "2025-03-10 09:00:00",
  "alert_date": "2025-03-20 10:00:00",
  "title": "Call back John Doe regarding apartment viewing",
  "contact_id": 45
}

• id (int): The system id of the reminder.
• user_id (int): The user ID of the user who will receive the alert.
• date_created (string): The date and time the reminder was created in YYYY-MM-DD HH:MM:SS format.
• alert_date (string): The date and time the reminder will fire in YYYY-MM-DD HH:MM:SS format (Europe/Athens timezone).
• title (string): The reminder message/title.
• contact_id (int, nullable): The ID of the linked contact, or null if not linked to a contact.

Create reminder

/api/reminders (POST)

Create a new reminder for a user.

Request

• Method: POST
• Headers: Include authentication headers as described in the Authentication section.
• Body: JSON object with the reminder details.

Field	Type	Required	Description
user_id	int	Yes	The user ID who will receive the alert. Must be an active user.
title	string	Yes	The reminder message.
datetime	string	Yes	When to fire the alert. Must be a future date/time. Accepted in any standard format (e.g., YYYY-MM-DD HH:MM:SS). Stored in Europe/Athens timezone.
contact_id	int	No	Links the reminder to a contact.

Example Body

{
  "user_id": 3,
  "title": "Call back John Doe regarding apartment viewing",
  "datetime": "2025-03-20 10:00:00",
  "contact_id": 45
}

Response

• 200 OK: Returns the created reminder ID.

Example Response

{
  "status": 200,
  "id": 14
}

Errors

Code	Message	Reason
400	Missing user_id	user_id was not provided.
400	Missing title	title was not provided or is empty.
400	Missing datetime	datetime was not provided.
400	Invalid datetime format	datetime could not be parsed.
400	Datetime must be in the future	The provided datetime is in the past.
400	User not found	No active user exists with the given user_id.
404	Contact not found	No contact exists with the given contact_id.