İçeriğe geç
Geliştiriciler

Endpoint'ler

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.

Yollar temel URL'ye göredir. Her kart, çağrının gerektirdiği izni ve her parametreyi türü ve sınırlarıyla listeler.

GET
/reminders

List reminders, newest first.

Herhangi bir ekip üyesi
Sayfalı

Sorgu parametreleri

  • statusisteğe bağlıenum

    Reminder state.

    İzin verilen değerler:opensnoozedclosed

  • assigned_toisteğe bağlıstring

    Reminders assigned to this user.

  • entity_typeisteğe bağlıenum

    What the reminder is about.

    İzin verilen değerler:contactconversationappointmentbooking

  • entity_idisteğe bağlıinteger

    ID of that record. Needs entity_type.

  • due_beforeisteğe bağlıstring (ISO 8601 date-time with offset)

    Due at or before this time.

  • due_afteristeğe bağlıstring (ISO 8601 date-time with offset)

    Due at or after this time.

GET
/reminders/:id

Retrieve a reminder.

Herhangi bir ekip üyesi

Yol parametreleri

  • idzorunluinteger

    Reminder ID.

POST
/reminders

Create a reminder.

Herhangi bir ekip üyesi

JSON gövdesi

  • titlezorunlustring

    1–200 characters, single line.

  • due_atzorunlustring (ISO 8601 date-time with offset)

    When the reminder is due.

  • entity_typezorunluenum

    What the reminder is about.

    İzin verilen değerler:contactconversationappointmentbooking

  • entity_idzorunluinteger

    ID of that record.

  • noteisteğe bağlıstring

    Up to 4,700 characters.

  • assigned_user_idsisteğe bağlıarray of strings

    1–50 user IDs from GET /users.

PATCH
/reminders/:id

Update a reminder. Send at least one field.

Herhangi bir ekip üyesi

Yol parametreleri

  • idzorunluinteger

    Reminder ID.

JSON gövdesi

  • titleisteğe bağlıstring

    1–200 characters, single line.

  • noteisteğe bağlıstring | null

    Up to 4,700 characters.

  • due_atisteğe bağlıstring (ISO 8601 date-time with offset)

    New due time.

  • assigned_user_idsisteğe bağlıarray of strings

    1–50 user IDs.

POST
/reminders/:id/snooze

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

Herhangi bir ekip üyesi

Yol parametreleri

  • idzorunluinteger

    Reminder ID.

JSON gövdesi

  • untilisteğe bağlıstring (ISO 8601 date-time with offset)

    New due time.

  • presetisteğe bağlıenum

    A quick snooze.

    İzin verilen değerler:1h3htomorrow_92d1w

POST
/reminders/:id/close

Mark a reminder done.

Herhangi bir ekip üyesi

Yol parametreleri

  • idzorunluinteger

    Reminder ID.

POST
/reminders/:id/assign

Replace the people assigned to a reminder.

Herhangi bir ekip üyesi

Yol parametreleri

  • idzorunluinteger

    Reminder ID.

JSON gövdesi

  • user_idszorunluarray of strings

    1–50 user IDs.

DELETE
/reminders/:id

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

Herhangi bir ekip üyesi

Yol parametreleri

  • idzorunluinteger

    Reminder ID.