built-in-templates

Change a built-in template's config

Change the caller's own config for a built-in task, such as the sources a Daily Brief reads. For the Ad Anomaly Watch, its creator or a workspace admin changes the workspace's watch. Fields left out keep their stored value.

put/v1/built-in-templates/{key}/config

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

Path parameters

keystring required

Headers

X-Tenant-Idstring nullable

Request body

configobject nullable required

The fields to change. A field left out keeps its stored value, and each template decides the rest. Daily Brief and the email sweeps: a field set to null clears that pick, and a null config clears every pick. email_accounts is a list of connected mailbox account ids; null or an empty list means every mailbox. Ad Anomaly Watch: a null config resets every setting to its default and keeps the watch's memory.

cron_job_idstring uuid nullable

The automation row the caller opened. When set, only that row changes.

Example request

{
  "config": {
    "email_accounts": [
      "0b6c1a52-8d3e-4f7a-9c21-5e4d7a8b9c10"
    ]
  }
}

Response

The built-in template with its new config.

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.