Перейти к содержимому
Разработчикам

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.

Любой участник команды
Постраничный

Параметры запроса

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