Μετάβαση στο περιεχόμενο
Προγραμματιστές

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.

Οι διαδρομές είναι σχετικές με το βασικό URL. Κάθε κάρτα δείχνει το δικαίωμα που απαιτεί η κλήση και κάθε παράμετρο, με τον τύπο και τα όριά της.

GET
/reminders

List reminders, newest first.

Οποιοδήποτε μέλος της ομάδας
Με σελιδοποίηση

Παράμετροι query

  • 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.

Οποιοδήποτε μέλος της ομάδας

Σώμα 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.

Σώμα 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.

Σώμα 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.

Σώμα 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.