Create a reminder for a contact

curl --request POST \ --url https://your-instance.example.com/api/reminders \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "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", "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" } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

contactId

string

required

note

string

required

reminderDate

string<date-time>

required

ISO timestamp; must be in the future

localTimestamp

string

Caller-supplied local-time representation (optional)

channelType

string

default:sms

phoneNumber

string

messengerId

string

webchatId

string

contactName

string

Response

Reminder created successfully

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes

Example:

{
  "_id": "65f0a0b0c0d0e0f0a0b0c0d0",
  "contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
  "organizationId": "65a0e0e0e0e0e0e0e0e0e0e0",
  "createdBy": "65b1f0a2c3d4e5f6a7b8c9d0",
  "note": "Follow up on demo booking",
  "reminderDate": "2026-05-22T15:00:00.000Z",
  "channelType": "sms",
  "phoneNumber": "+14155550123",
  "contactName": "Jane Doe",
  "fired": false,
  "createdAt": "2026-05-18T12:00:00.000Z",
  "updatedAt": "2026-05-18T12:00:00.000Z"
}

message

string