built-in-templates

Enable a built-in template

Enable a built-in scheduled task. A local start time may be chosen on the first enable only, except for a template with a fixed schedule, which refuses one. A later enable restores the task's own preserved schedule and refuses a supplied local_time.

post/v1/built-in-templates/{key}/enable

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/built-in-templates/{key}/enable
  • Auth: HTTP bearer

Path parameters

keystring required

Headers

X-Tenant-Idstring nullable

Request body

local_timestring nullable

Local start time as exactly HH:MM on a 24-hour clock, in the caller's own timezone. Accepted on the first enable only, and refused for a template with a fixed schedule.

delivery_channel_idstring nullable

Channel a per-meeting template delivers to, chosen on the first enable only. Omit it to deliver by direct message. Refused for a scheduled template.

configobject nullable

The person's picks for a template that has config, chosen on the first enable only. Omit it to use every source the person can use. Refused for a template with no config. The Ad Anomaly Watch needs a settings object on its first enable, and {} means the defaults.

Example request

{
  "local_time": "08:00",
  "delivery_channel_id": "C0123456789",
  "config": {
    "calendar_source": "googlecalendar",
    "email_accounts": [
      "0b6c1a52-8d3e-4f7a-9c21-5e4d7a8b9c10"
    ]
  }
}

Response

The enabled built-in template and its schedule.

keystring required
titlestring required
descriptionstring required
enabledboolean required
schedulestring nullable required
local_schedulestring nullable required
timezonestring nullable required
cron_job_idstring uuid nullable required
trigger_kind'cron' | 'per_meeting' | 'before_each_meeting' required
instructions_status'available' | 'unavailable' | 'unknown' required
teammate_watch_onboolean
created_by_teammateboolean
createdboolean
config_optionsobject
reads_mailboolean

True when the template reads the person's mailboxes and offers a choice of which.

fixed_local_timestring nullable

The local HH:MM a fixed-schedule template always runs at, Monday to Friday, in the person's own timezone and direct messages. Null when the person chooses the schedule.

connection_scope_notestring required

Example response

{
  "fixed_local_time": "12:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.