Ir al contenido
Desarrolladores

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.

Las rutas son relativas a la URL base. Cada tarjeta indica el permiso que necesita la llamada y cada parámetro, con su tipo y sus límites.

GET
/reminders

List reminders, newest first.

Cualquier miembro del equipo
Paginado

Parámetros de consulta

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

Cualquier miembro del equipo

Parámetros de ruta

  • idobligatoriointeger

    Reminder ID.

POST
/reminders

Create a reminder.

Cualquier miembro del equipo

Cuerpo JSON

  • titleobligatoriostring

    1–200 characters, single line.

  • due_atobligatoriostring (ISO 8601 date-time with offset)

    When the reminder is due.

  • entity_typeobligatorioenum

    What the reminder is about.

    Valores permitidos:contactconversationappointmentbooking

  • entity_idobligatoriointeger

    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.

Cualquier miembro del equipo

Parámetros de ruta

  • idobligatoriointeger

    Reminder ID.

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

Cualquier miembro del equipo

Parámetros de ruta

  • idobligatoriointeger

    Reminder ID.

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

Cualquier miembro del equipo

Parámetros de ruta

  • idobligatoriointeger

    Reminder ID.

POST
/reminders/:id/assign

Replace the people assigned to a reminder.

Cualquier miembro del equipo

Parámetros de ruta

  • idobligatoriointeger

    Reminder ID.

Cuerpo JSON

  • user_idsobligatorioarray of strings

    1–50 user IDs.

DELETE
/reminders/:id

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

Cualquier miembro del equipo

Parámetros de ruta

  • idobligatoriointeger

    Reminder ID.