انتقل إلى المحتوى
المطورون

الـ Endpoints

Reminders

Team reminders on contacts, conversations and bookings. The workspace owner sees every reminder; anyone else sees the reminders they created or are assigned to.

المسارات نسبية للـ base URL. كل كارت بيوضّح الصلاحية اللي الاستدعاء محتاجها وكل parameter، مع نوعه وحدوده.

GET
/reminders

List reminders, newest first.

أي عضو في الفريق
مقسّم لصفحات

معاملات الاستعلام

  • statusاختياريenum

    Reminder state.

    القيم المسموحة:opensnoozedclosed

  • assigned_toاختياريstring

    Reminders assigned to this user.

  • entity_typeاختياريenum

    What the reminder is about.

    القيم المسموحة:contactconversationappointmentbooking

  • entity_idاختياريinteger

    ID of that record. Needs entity_type.

  • due_beforeاختياريstring (ISO 8601 date-time with offset)

    Due at or before this time.

  • due_afterاختياريstring (ISO 8601 date-time with offset)

    Due at or after this time.

GET
/reminders/:id

Retrieve a reminder.

أي عضو في الفريق

معاملات المسار

  • idمطلوبinteger

    Reminder ID.

POST
/reminders

Create a reminder.

أي عضو في الفريق

الـ body بصيغة JSON

  • titleمطلوبstring

    1–200 characters, single line.

  • due_atمطلوبstring (ISO 8601 date-time with offset)

    When the reminder is due.

  • entity_typeمطلوبenum

    What the reminder is about.

    القيم المسموحة:contactconversationappointmentbooking

  • entity_idمطلوبinteger

    ID of that record.

  • noteاختياريstring

    Up to 4,700 characters.

  • assigned_user_idsاختياريarray of strings

    1–50 user IDs from GET /users.

PATCH
/reminders/:id

Update a reminder. Send at least one field.

أي عضو في الفريق

معاملات المسار

  • idمطلوبinteger

    Reminder ID.

الـ body بصيغة JSON

  • titleاختياريstring

    1–200 characters, single line.

  • noteاختياريstring | null

    Up to 4,700 characters.

  • due_atاختياريstring (ISO 8601 date-time with offset)

    New due time.

  • assigned_user_idsاختياريarray of strings

    1–50 user IDs.

POST
/reminders/:id/snooze

Move a reminder to later. Send exactly one of until or preset.

أي عضو في الفريق

معاملات المسار

  • idمطلوبinteger

    Reminder ID.

الـ body بصيغة JSON

  • untilاختياريstring (ISO 8601 date-time with offset)

    New due time.

  • presetاختياريenum

    A quick snooze.

    القيم المسموحة:1h3htomorrow_92d1w

POST
/reminders/:id/close

Mark a reminder done.

أي عضو في الفريق

معاملات المسار

  • idمطلوبinteger

    Reminder ID.

POST
/reminders/:id/assign

Replace the people assigned to a reminder.

أي عضو في الفريق

معاملات المسار

  • idمطلوبinteger

    Reminder ID.

الـ body بصيغة JSON

  • user_idsمطلوبarray of strings

    1–50 user IDs.

DELETE
/reminders/:id

Delete a reminder. Only its creator or the workspace owner can.

أي عضو في الفريق

معاملات المسار

  • idمطلوبinteger

    Reminder ID.