Zum Inhalt springen
Entwickler

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.

Pfade sind relativ zur Basis-URL. Jede Karte zeigt die Berechtigung, die der Aufruf braucht, und jeden Parameter mit Typ und Grenzen.

GET
/reminders

List reminders, newest first.

Jedes Teammitglied
Paginiert

Query-Parameter

  • statusoptionalenum

    Reminder state.

    Erlaubte Werte:opensnoozedclosed

  • assigned_tooptionalstring

    Reminders assigned to this user.

  • entity_typeoptionalenum

    What the reminder is about.

    Erlaubte Werte:contactconversationappointmentbooking

  • entity_idoptionalinteger

    ID of that record. Needs entity_type.

  • due_beforeoptionalstring (ISO 8601 date-time with offset)

    Due at or before this time.

  • due_afteroptionalstring (ISO 8601 date-time with offset)

    Due at or after this time.

GET
/reminders/:id

Retrieve a reminder.

Jedes Teammitglied

Pfadparameter

  • iderforderlichinteger

    Reminder ID.

POST
/reminders

Create a reminder.

Jedes Teammitglied

JSON-Body

  • titleerforderlichstring

    1–200 characters, single line.

  • due_aterforderlichstring (ISO 8601 date-time with offset)

    When the reminder is due.

  • entity_typeerforderlichenum

    What the reminder is about.

    Erlaubte Werte:contactconversationappointmentbooking

  • entity_iderforderlichinteger

    ID of that record.

  • noteoptionalstring

    Up to 4,700 characters.

  • assigned_user_idsoptionalarray of strings

    1–50 user IDs from GET /users.

PATCH
/reminders/:id

Update a reminder. Send at least one field.

Jedes Teammitglied

Pfadparameter

  • iderforderlichinteger

    Reminder ID.

JSON-Body

  • titleoptionalstring

    1–200 characters, single line.

  • noteoptionalstring | null

    Up to 4,700 characters.

  • due_atoptionalstring (ISO 8601 date-time with offset)

    New due time.

  • assigned_user_idsoptionalarray of strings

    1–50 user IDs.

POST
/reminders/:id/snooze

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

Jedes Teammitglied

Pfadparameter

  • iderforderlichinteger

    Reminder ID.

JSON-Body

  • untiloptionalstring (ISO 8601 date-time with offset)

    New due time.

  • presetoptionalenum

    A quick snooze.

    Erlaubte Werte:1h3htomorrow_92d1w

POST
/reminders/:id/close

Mark a reminder done.

Jedes Teammitglied

Pfadparameter

  • iderforderlichinteger

    Reminder ID.

POST
/reminders/:id/assign

Replace the people assigned to a reminder.

Jedes Teammitglied

Pfadparameter

  • iderforderlichinteger

    Reminder ID.

JSON-Body

  • user_idserforderlicharray of strings

    1–50 user IDs.

DELETE
/reminders/:id

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

Jedes Teammitglied

Pfadparameter

  • iderforderlichinteger

    Reminder ID.