Skip to main content
PATCH
Update an automation

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The automation ID.

Minimum string length: 1

Body

application/json
name
string

A new name.

Required string length: 1 - 120
description
string | null

A new summary. Pass null to clear it.

Maximum string length: 2000
instructions
string

New instructions that replace the current ones. They take effect on the next run and don't change a run in progress.

Required string length: 1 - 20000
triggers
object

Triggers to add or remove. Triggers you don't mention are left unchanged. To change a trigger, remove it and add its replacement in the same call. An automation can have at most 10.

status
enum<string>

paused puts every trigger on hold and keeps the automation and its run history. active resumes them.

Available options:
active,
paused
projectId
string | null

A project to run the automation in, which needs edit access to it. Pass null to run it across the organization.

Minimum string length: 1

Response

OK

id
string
required

The automation ID.

Minimum string length: 1
name
string
required

The automation name.

description
string | null
required

A short summary of what the automation does, or null.

status
enum<string>
required

active: the automation runs when its triggers fire. paused: its triggers are on hold, and the automation only runs when someone starts a run.

Available options:
active,
paused
nextRunAt
string<date-time> | null
required

When a trigger next starts a run, or null for an automation that is paused or has no scheduled trigger.

project
object | null
required

The project the automation runs in, with that project's files, notes, and linked records as its context, or null for an automation that runs across the organization.

lastRun
object | null
required

The most recent run, or null for an automation that has never run.

createdAt
string<date-time>
required

When the automation was created.

updatedAt
string<date-time>
required

When the automation or its triggers were last changed.

triggers
object[]
required

What starts the automation on its own, oldest first. Empty for an automation that only runs when someone starts a run.

Something that starts a run. cron: a schedule. event: something that happens in Parley. More types will be added, so skip any type you do not recognize.

instructions
string
required

The automation's instructions: the prompt Parley's assistant carries out on every run.