Skip to main content

autessa.phoneReminder

8 methods in the phoneReminder namespace.

autessa.phoneReminder.createMUTATE

autessa.phoneReminder.create({ displayName, reminderPhoneNumber, leadTimeMinutes, quietHoursEnabled, quietHoursStart, quietHoursEnd, quietHoursTimezone, calendarConnectorIds })

Create a phone-reminder setup, provisioning its number, table, tools, agent, and recurring calendar scan.

Requires at least one calendarConnectorId. Provisions an Autessa Twilio number, a dependent AutessaDB tracking table, per-config tools plus a voice reminder agent, and a recurring 30-minute calendar-scan scheduled event that books a reminder call leadTimeMinutes before each upcoming meeting. leadTimeMinutes defaults to 3 (allowed range 1-60); reminderPhoneNumber must be E.164 (e.g. +15551234567); quiet-hours start/end are HH:mm. Purchasing a phone number is a billable side effect.

Request fields

  • Name
    displayName
    Type
    string
    Description
  • Name
    reminderPhoneNumber
    Type
    string
    Description
  • Name
    leadTimeMinutes
    Type
    number
    Description
  • Name
    quietHoursEnabled
    Type
    boolean
    Description
  • Name
    quietHoursStart
    Type
    string
    Description
  • Name
    quietHoursEnd
    Type
    string
    Description
  • Name
    quietHoursTimezone
    Type
    string
    Description
  • Name
    calendarConnectorIds
    Type
    string (opaque id)[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    config
    Type
    PhoneReminderConfigDto
    Description

autessa.phoneReminder.deleteMUTATE

autessa.phoneReminder.delete({ configId })

Permanently delete a phone-reminder setup and every resource it provisioned.

Irreversible hard delete. Cascades: removes the recurring scan schedule, drops the AutessaDB tracking table (and its Postgres table, storage, vectors, triggers, permissions), deletes the per-config tools and voice agent, and releases the Twilio number so it stops billing. Shared orchestrator primitives remain for reuse.

Request fields

  • Name
    configId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    deleted
    Type
    boolean
    Description

autessa.phoneReminder.getREAD

autessa.phoneReminder.get({ configId })

Fetch one of your phone-reminder setups by id.

Returns the full setup, including the provisioned resource ids (table, tools, agent, scan job) and the Autessa number the call comes from. Fails if the setup does not exist or you do not own it.

Request fields

  • Name
    configId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    config
    Type
    PhoneReminderConfigDto
    Description

autessa.phoneReminder.listREAD

autessa.phoneReminder.list()

List all of your phone-reminder setups in the current company.

Returns every non-deleted setup you own in the current company. Not paginated; takes no request fields.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    configs
    Type
    PhoneReminderConfigDto[]
    Description

autessa.phoneReminder.resetMUTATE

autessa.phoneReminder.reset({ configId })

Tear a setup fully down and re-provision it from the same settings (the Autessa number changes).

Full teardown + recreate: releases the number, drops the tracking table, and deletes the per-config tools/agent/scan job, then re-provisions everything with the same settings. Use it to recover a setup whose provisioned resources are broken. The Autessa phone number changes as a result. If the recreate step fails, the setup is gone and must be created again — same as a failed first-time setup.

Request fields

  • Name
    configId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    config
    Type
    PhoneReminderConfigDto
    Description

autessa.phoneReminder.scanNowMUTATE

autessa.phoneReminder.scanNow({ configId })

Run the calendar scan immediately instead of waiting for the next 30-minute tick.

The UI's Refresh action. Runs the scan orchestrator now with the setup's current settings: it refreshes calendar coverage, lists the next 24h of meetings on the linked calendars, and books/updates reminder calls the same way the recurring tick does. Returns the scan run's summary text.

Request fields

  • Name
    configId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    summary
    Type
    string
    Description

autessa.phoneReminder.updateCalendarsMUTATE

autessa.phoneReminder.updateCalendars({ configId, calendarConnectorIds })

Replace the set of calendar connectors a setup watches.

Replace-set semantics: after the call the setup watches exactly the connectors in calendarConnectorIds — omitted ones are unlinked, new ones are added. At least one connector is required. Refreshes the scan job so the next scan uses the new calendar set.

Request fields

  • Name
    configId
    Type
    string
    Description
  • Name
    calendarConnectorIds
    Type
    string (opaque id)[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    config
    Type
    PhoneReminderConfigDto
    Description

autessa.phoneReminder.updateSettingsMUTATE

autessa.phoneReminder.updateSettings({ configId, reminderPhoneNumber, leadTimeMinutes, quietHoursEnabled, quietHoursStart, quietHoursEnd, quietHoursTimezone, isEnabled })

Update a setup's phone number, lead time, quiet hours, and enabled flag.

Partial update: only non-null fields are applied; the rest are left unchanged. The new values are written into the recurring scan event's variables, so the next scan tick uses them (calls already booked keep the settings they were booked with, up to ~24h). leadTimeMinutes must be 1-60 and reminderPhoneNumber must be E.164 when supplied. Set isEnabled false to pause reminders without deleting the setup.

Request fields

  • Name
    configId
    Type
    string
    Description
  • Name
    reminderPhoneNumber
    Type
    string
    Description
  • Name
    leadTimeMinutes
    Type
    number
    Description
  • Name
    quietHoursEnabled
    Type
    boolean
    Description
  • Name
    quietHoursStart
    Type
    string
    Description
  • Name
    quietHoursEnd
    Type
    string
    Description
  • Name
    quietHoursTimezone
    Type
    string
    Description
  • Name
    isEnabled
    Type
    boolean
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    config
    Type
    PhoneReminderConfigDto
    Description