Skip to main content

Message Reply Tracking

Reply tracking allows the system to monitor for responses to a sent message and notify you when a reply is received.

How to Enable Tracking​

When sending a message, include the track_reply parameter set to true:

{
  "track_reply": true
}

Optional: Set Tracking Frequency​

You can also include an optional frequency parameter (in hours).
If not specified, the default frequency is 1 hour.

{
  "track_reply": true,
  "frequency": 2
}

How It Works​

  • Once tracking is enabled, the system will periodically call the /api/v1/personal_messages endpoint.
  • If a reply is detected for the original message thread:
    • The user is alerted.
    • Tracking for that thread automatically stops.
  • If no reply is found:
    • Tracking continues indefinitely at the specified frequency.
    • ⚠️ Use caution when enabling tracking, especially without a defined end condition.

Disabling Reply Tracking​

You can stop reply tracking at any time using the following endpoint:

POST /api/v1/update_message_tracker

Example Request​

{
  "tracker_id": "your-tracker-id"
}
  • Replace tracker_id with the actual ID of the tracker you want to disable.
  • This will stop reply tracking for the associated message thread.

When to Use​

  • If you no longer expect a reply
  • If the user cancels tracking from your interface
  • To clean up trackers that are no longer needed

Tracking also stops automatically once a reply is detected.

Best Practices​

  • Set an appropriate frequency to balance responsiveness and system load.
  • Consider implementing logic on your end to disable tracking after a certain time if no reply is received.