Endpoint

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.

I percorsi sono relativi all'URL di base. Ogni scheda indica il permesso richiesto dalla chiamata e ogni parametro, con tipo e limiti.

GET

/reminders

List reminders, newest first.

Qualsiasi membro del team

Paginato

Parametri di query

statusopzionaleenum
Reminder state.
Valori consentiti:opensnoozedclosed
assigned_toopzionalestring
Reminders assigned to this user.
entity_typeopzionaleenum
What the reminder is about.
Valori consentiti:contactconversationappointmentbooking
entity_idopzionaleinteger
ID of that record. Needs entity_type.
due_beforeopzionalestring (ISO 8601 date-time with offset)
Due at or before this time.
due_afteropzionalestring (ISO 8601 date-time with offset)
Due at or after this time.

GET

/reminders/:id

Retrieve a reminder.

Qualsiasi membro del team

Parametri del percorso

idobbligatoriointeger
Reminder ID.

POST

/reminders

Create a reminder.

Qualsiasi membro del team

Corpo JSON

titleobbligatoriostring
1–200 characters, single line.
due_atobbligatoriostring (ISO 8601 date-time with offset)
When the reminder is due.
entity_typeobbligatorioenum
What the reminder is about.
Valori consentiti:contactconversationappointmentbooking
entity_idobbligatoriointeger
ID of that record.
noteopzionalestring
Up to 4,700 characters.
assigned_user_idsopzionalearray of strings
1–50 user IDs from GET /users.

PATCH

/reminders/:id

Update a reminder. Send at least one field.

Qualsiasi membro del team

Parametri del percorso

idobbligatoriointeger
Reminder ID.

Corpo JSON

titleopzionalestring
1–200 characters, single line.
noteopzionalestring | null
Up to 4,700 characters.
due_atopzionalestring (ISO 8601 date-time with offset)
New due time.
assigned_user_idsopzionalearray of strings
1–50 user IDs.

POST

/reminders/:id/snooze

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

Qualsiasi membro del team

Parametri del percorso

idobbligatoriointeger
Reminder ID.

Corpo JSON

untilopzionalestring (ISO 8601 date-time with offset)
New due time.
presetopzionaleenum
A quick snooze.
Valori consentiti:1h3htomorrow_92d1w

POST

/reminders/:id/close

Mark a reminder done.

Qualsiasi membro del team

Parametri del percorso

idobbligatoriointeger
Reminder ID.

POST

/reminders/:id/assign

Replace the people assigned to a reminder.

Qualsiasi membro del team

Parametri del percorso

idobbligatoriointeger
Reminder ID.

Corpo JSON

user_idsobbligatorioarray of strings
1–50 user IDs.

DELETE

/reminders/:id

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

Qualsiasi membro del team

Parametri del percorso

idobbligatoriointeger
Reminder ID.