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.

Les chemins sont relatifs à l’URL de base. Chaque carte indique la permission requise par l’appel et chaque paramètre, avec son type et ses limites.

GET

/reminders

List reminders, newest first.

Tout membre de l’équipe

Paginé

Paramètres de requête

statusfacultatifenum
Reminder state.
Valeurs autorisées :opensnoozedclosed
assigned_tofacultatifstring
Reminders assigned to this user.
entity_typefacultatifenum
What the reminder is about.
Valeurs autorisées :contactconversationappointmentbooking
entity_idfacultatifinteger
ID of that record. Needs entity_type.
due_beforefacultatifstring (ISO 8601 date-time with offset)
Due at or before this time.
due_afterfacultatifstring (ISO 8601 date-time with offset)
Due at or after this time.

GET

/reminders/:id

Retrieve a reminder.

Tout membre de l’équipe

Paramètres de chemin

idobligatoireinteger
Reminder ID.

POST

/reminders

Create a reminder.

Tout membre de l’équipe

Corps JSON

titleobligatoirestring
1–200 characters, single line.
due_atobligatoirestring (ISO 8601 date-time with offset)
When the reminder is due.
entity_typeobligatoireenum
What the reminder is about.
Valeurs autorisées :contactconversationappointmentbooking
entity_idobligatoireinteger
ID of that record.
notefacultatifstring
Up to 4,700 characters.
assigned_user_idsfacultatifarray of strings
1–50 user IDs from GET /users.

PATCH

/reminders/:id

Update a reminder. Send at least one field.

Tout membre de l’équipe

Paramètres de chemin

idobligatoireinteger
Reminder ID.

Corps JSON

titlefacultatifstring
1–200 characters, single line.
notefacultatifstring | null
Up to 4,700 characters.
due_atfacultatifstring (ISO 8601 date-time with offset)
New due time.
assigned_user_idsfacultatifarray of strings
1–50 user IDs.

POST

/reminders/:id/snooze

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

Tout membre de l’équipe

Paramètres de chemin

idobligatoireinteger
Reminder ID.

Corps JSON

untilfacultatifstring (ISO 8601 date-time with offset)
New due time.
presetfacultatifenum
A quick snooze.
Valeurs autorisées :1h3htomorrow_92d1w

POST

/reminders/:id/close

Mark a reminder done.

Tout membre de l’équipe

Paramètres de chemin

idobligatoireinteger
Reminder ID.

POST

/reminders/:id/assign

Replace the people assigned to a reminder.

Tout membre de l’équipe

Paramètres de chemin

idobligatoireinteger
Reminder ID.

Corps JSON

user_idsobligatoirearray of strings
1–50 user IDs.

DELETE

/reminders/:id

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

Tout membre de l’équipe

Paramètres de chemin

idobligatoireinteger
Reminder ID.