PAparley
Automations

Update an automation

Rename an automation, replace its instructions, add or remove triggers, pause or resume it, or move it to another project. Omitted fields are left unchanged.

patch/automations/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/automations/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The automation ID.

Request body

namestring

A new name.

descriptionstring nullable

A new summary. Pass null to clear it.

instructionsstring

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

status'active' | 'paused'

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

projectIdstring nullable

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

Response

OK

idstring required

The automation ID.

namestring required

The automation name.

descriptionstring nullable required

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

status'active' | 'paused' 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.

nextRunAtstring date-time nullable required

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

createdAtstring date-time required

When the automation was created.

updatedAtstring date-time required

When the automation or its triggers were last changed.

instructionsstring required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.