built-in-templates

Disable a built-in template

Disable a built-in scheduled task while preserving its schedule.

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

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}/disable
  • Auth: HTTP bearer

Path parameters

keystring required

Headers

X-Tenant-Idstring nullable

Response

The disabled built-in template and its preserved 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.

Example response

{
  "fixed_local_time": "12:00"
}

Changes

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