Reminders

Create a reminder for a contact

POST
/api/reminders

Creates an unfired reminder for the given contact. reminderDate must parse to a valid future date. The reminder is scoped to the caller's organization. assigneeId decides who is notified when it fires and defaults to the calling user; pass null to create a silent reminder that notifies nobody. createdBy is recorded as provenance only.

Pass applicationId and/or conversationId to attach the reminder to the record it was composed from - both must belong to the caller's organization. contactId stays required and populated either way, so the reminder still rolls up to the contact.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reminders" \  -H "Content-Type: application/json" \  -d '{    "contactId": "65c2d0e0f0a0b0c0d0e0f0a0",    "note": "Follow up on demo booking",    "reminderDate": "2026-05-22T15:00:00.000Z",    "localTimestamp": "2026-05-22 11:00 EDT",    "channelType": "sms",    "phoneNumber": "+14155550123",    "contactName": "Jane Doe"  }'
{  "success": true,  "message": "Reminder created successfully",  "data": {    "_id": "65f0a0b0c0d0e0f0a0b0c0d0",    "contactId": "65c2d0e0f0a0b0c0d0e0f0a0",    "organizationId": "65a0e0e0e0e0e0e0e0e0e0e0",    "createdBy": "65b1f0a2c3d4e5f6a7b8c9d0",    "assigneeId": "65b1f0a2c3d4e5f6a7b8c9d0",    "note": "Follow up on demo booking",    "reminderDate": "2026-05-22T15:00:00.000Z",    "channelType": "sms",    "fired": false,    "createdAt": "2026-05-18T12:00:00.000Z",    "updatedAt": "2026-05-18T12:00:00.000Z"  }}