Skip to main content

MeetingRemindersState

The meeting plus its recalculated plan, returned together.

One response updates both the table row and the open details card, so the screen never shows a stale plan between two round-trips.

meeting objectrequired

A meeting scheduled with a lead through a connected calendar integration.

scheduled_atdate-timerequired

When the meeting is scheduled (UTC).

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

lead_idLead Idrequired

ID of the lead this record relates to.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

reminder_step_numberReminder Step Number

How many reminder steps have been sent for this meeting.

Default value: 0
is_cancelledIs Cancelled

Whether the meeting has been cancelled.

Default value: false
idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

integration_idIntegration Idrequired

ID of the calendar integration the meeting was booked through.

agent_integration_idAgent Integration Idrequired

ID of the agent-integration binding used to book the meeting.

config objectrequired

Booking details (calendar event, account, and service).

event objectrequired
idIdrequired

Unique numeric identifier of the record.

titleTitle
Default value: Unknown event
description object
anyOf
string
start objectrequired
anyOf
date-time
end objectrequired
anyOf
date-time
attendeesstring[]
link object
anyOf
string
service object
anyOf
idIdrequired

The service's id at the calendar provider.

nameNamerequired

The service's display name.

category_id object

Optional category id the service belongs to.

anyOf
string
llm_context object

Optional description given to the LLM to help it pick this service.

anyOf
string
is_enabled_in_calendarIs Enabled In Calendar

Whether the service is currently bookable.

Default value: true
booking_modesCalendarBookingMode[]

Possible values: [individual, group], >= 1

group_activity_id object
anyOf
string
clients_countClients Count
Default value: 1
account objectrequired

A bookable calendar account (e.g. a sales manager's calendar) exposed by a calendar integration.

idIdrequired

The account's id at the calendar provider.

nameNamerequired

The account's display name.

enabled_services_idsstring[]

IDs of the bookable services enabled for this account.

service object
anyOf
idIdrequired

The service's id at the calendar provider.

nameNamerequired

The service's display name.

category_id object

Optional category id the service belongs to.

anyOf
string
llm_context object

Optional description given to the LLM to help it pick this service.

anyOf
string
is_enabled_in_calendarIs Enabled In Calendar

Whether the service is currently bookable.

Default value: true
booking_modesCalendarBookingMode[]

Possible values: [individual, group], >= 1

should_skip_remindersShould Skip Reminders
Default value: false
skipped_reminder_stepsinteger[]
reminders object[]required
  • Array [
    • step_numberStep Numberrequired
    before_minutesBefore Minutesrequired
    send_atdate-timerequired
    statusMeetingReminderStatusrequired

    State of one configured reminder step for a specific meeting.

    Possible values: [sent, cancelled, due, scheduled]

  • ]
    • MeetingRemindersState
    {
      "meeting": {
        "scheduled_at": "2024-07-29T15:51:28.071Z",
        "product_id": 0,
        "lead_id": 0,
        "agent_id": 0,
        "dialogue_id": 0,
        "reminder_step_number": 0,
        "is_cancelled": false,
        "id": 0,
        "created_at": "2024-07-29T15:51:28.071Z",
        "integration_id": 0,
        "agent_integration_id": 0,
        "config": {
          "event": {
            "id": "string",
            "title": "Unknown event",
            "description": "string",
            "start": "2024-07-29T15:51:28.071Z",
            "end": "2024-07-29T15:51:28.071Z",
            "attendees": [
              "string"
            ],
            "link": "string",
            "service": {
              "id": "string",
              "name": "string",
              "category_id": "string",
              "llm_context": "string",
              "is_enabled_in_calendar": true,
              "booking_modes": [
                "individual"
              ]
            },
            "group_activity_id": "string",
            "clients_count": 1
          },
          "account": {
            "id": "string",
            "name": "string",
            "enabled_services_ids": [
              "string"
            ]
          },
          "service": {
            "id": "string",
            "name": "string",
            "category_id": "string",
            "llm_context": "string",
            "is_enabled_in_calendar": true,
            "booking_modes": [
              "individual"
            ]
          }
        },
        "should_skip_reminders": false,
        "skipped_reminder_steps": [
          0
        ]
      },
      "reminders": [
        {
          "step_number": 0,
          "before_minutes": 0,
          "send_at": "2024-07-29T15:51:28.071Z",
          "status": "sent"
        }
      ]
    }