Ir para o conteúdo
Desenvolvedores

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.

Os caminhos são relativos à URL base. Cada card lista a permissão que a chamada exige e todos os parâmetros, com tipo e limites.

GET
/reminders

List reminders, newest first.

Qualquer membro da equipe
Paginado

Parâmetros de query

  • statusopcionalenum

    Reminder state.

    Valores permitidos:opensnoozedclosed

  • assigned_toopcionalstring

    Reminders assigned to this user.

  • entity_typeopcionalenum

    What the reminder is about.

    Valores permitidos:contactconversationappointmentbooking

  • entity_idopcionalinteger

    ID of that record. Needs entity_type.

  • due_beforeopcionalstring (ISO 8601 date-time with offset)

    Due at or before this time.

  • due_afteropcionalstring (ISO 8601 date-time with offset)

    Due at or after this time.

GET
/reminders/:id

Retrieve a reminder.

Qualquer membro da equipe

Parâmetros de caminho

  • idobrigatóriointeger

    Reminder ID.

POST
/reminders

Create a reminder.

Qualquer membro da equipe

Corpo JSON

  • titleobrigatóriostring

    1–200 characters, single line.

  • due_atobrigatóriostring (ISO 8601 date-time with offset)

    When the reminder is due.

  • entity_typeobrigatórioenum

    What the reminder is about.

    Valores permitidos:contactconversationappointmentbooking

  • entity_idobrigatóriointeger

    ID of that record.

  • noteopcionalstring

    Up to 4,700 characters.

  • assigned_user_idsopcionalarray of strings

    1–50 user IDs from GET /users.

PATCH
/reminders/:id

Update a reminder. Send at least one field.

Qualquer membro da equipe

Parâmetros de caminho

  • idobrigatóriointeger

    Reminder ID.

Corpo JSON

  • titleopcionalstring

    1–200 characters, single line.

  • noteopcionalstring | null

    Up to 4,700 characters.

  • due_atopcionalstring (ISO 8601 date-time with offset)

    New due time.

  • assigned_user_idsopcionalarray of strings

    1–50 user IDs.

POST
/reminders/:id/snooze

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

Qualquer membro da equipe

Parâmetros de caminho

  • idobrigatóriointeger

    Reminder ID.

Corpo JSON

  • untilopcionalstring (ISO 8601 date-time with offset)

    New due time.

  • presetopcionalenum

    A quick snooze.

    Valores permitidos:1h3htomorrow_92d1w

POST
/reminders/:id/close

Mark a reminder done.

Qualquer membro da equipe

Parâmetros de caminho

  • idobrigatóriointeger

    Reminder ID.

POST
/reminders/:id/assign

Replace the people assigned to a reminder.

Qualquer membro da equipe

Parâmetros de caminho

  • idobrigatóriointeger

    Reminder ID.

Corpo JSON

  • user_idsobrigatórioarray of strings

    1–50 user IDs.

DELETE
/reminders/:id

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

Qualquer membro da equipe

Parâmetros de caminho

  • idobrigatóriointeger

    Reminder ID.