Update automation
Update an existing automation. All fields are optional — only supplied fields are changed. Updating cron or timezone triggers the same 15-minute minimum-interval validation as creation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the agent that owns the automation.
The ID of the automation to update.
Body
Updated human-readable name for the automation.
255Updated description.
600Set to true to resume scheduling; false to pause. Pausing does not delete the automation or its history. Null is treated as unset (no change).
Updated five-field cron expression. The same 15-minute minimum interval rule applies. Pass null to leave the schedule unchanged.
255"30 8 * * 1-5"
Updated IANA timezone. Pass null to leave unchanged.
"Europe/London"
Updated instruction text for the agent. Pass null to leave unchanged. Must not be empty or whitespace-only.
20000Controls whether each scheduled run creates a fresh conversation thread or continues in the same persistent conversation.
new_thread— (default) Each run starts a new conversation. Results are isolated; the agent has no memory of prior runs unless it uses agent memory tools.same_conversation— Every run appends to the same conversation thread. The agent sees the full history of prior runs, which is useful for incremental summaries or stateful workflows.
new_thread, same_conversation Where the automation's conversation runs and results are delivered.
agent_dm— (default) Results are posted in the agent's own DM space. Nodestination_idis required.channel— Results are posted in a specific Datagrid channel. Provide the channel ID indestination_id.user_dm— Results are sent as a direct message to a specific user. Provide the user ID indestination_id.
agent_dm, channel, user_dm Updated destination channel or user ID.
255Updated output delivery channel ID. Must be provided together with output_channel_type in the resulting configuration — supplying one without the other is rejected with a 400 error. This is an external transport address, not a Datagrid-owned resource — it's validated against the caller's own connected integrations at delivery time.
255Updated transport type for the output channel. One of "email", "slack", "teams", "sms". Must be provided together with output_channel_id in the resulting configuration.
email, slack, teams, sms Controls when users are notified about automation run outcomes.
always— Notify after every run regardless of success or failure. -on_failure— (default) Notify only when a run fails or produces an error.never— Do not send notifications for this automation.
always, on_failure, never Updated list of file IDs to attach as context. Each file must exist and belong to the caller's teamspace, or the request is rejected with a 404 error. Limited to 20 IDs per request.
20Response
Updated automation
The object type, always 'automation'.
automation Unique identifier for the automation.
Human-readable name of the automation.
Optional free-text description of what this automation does.
Whether the automation is active. When false the cron trigger is paused and no runs are scheduled until it is re-enabled.
ISO 8601 timestamp of when the automation was created.
Five-field cron expression controlling when the automation fires (e.g. "0 9 * * 1" = every Monday at 09:00). Seconds are not supported. Must have a minimum inter-fire interval of 15 minutes.
"0 9 * * 1"
IANA timezone identifier in which cron is interpreted (e.g. "America/New_York", "UTC"). Defaults to "UTC" when not provided on create.
"America/New_York"
The instruction text sent to the agent each time the automation fires. Supports Markdown.
Controls whether each scheduled run creates a fresh conversation thread or continues in the same persistent conversation.
new_thread— (default) Each run starts a new conversation. Results are isolated; the agent has no memory of prior runs unless it uses agent memory tools.same_conversation— Every run appends to the same conversation thread. The agent sees the full history of prior runs, which is useful for incremental summaries or stateful workflows.
new_thread, same_conversation ISO 8601 timestamp of the last modification.
Where the automation's conversation runs and results are delivered.
agent_dm— (default) Results are posted in the agent's own DM space. Nodestination_idis required.channel— Results are posted in a specific Datagrid channel. Provide the channel ID indestination_id.user_dm— Results are sent as a direct message to a specific user. Provide the user ID indestination_id.
agent_dm, channel, user_dm The channel ID or user ID that identifies the destination. Required when destination_type is channel or user_dm; omit for agent_dm.
ID of an additional delivery channel (Slack channel, Teams channel, email address, etc.) where automation results are also posted.
The transport type of the output channel. One of "email", "slack", "teams", "sms".
Controls when users are notified about automation run outcomes.
always— Notify after every run regardless of success or failure. -on_failure— (default) Notify only when a run fails or produces an error.never— Do not send notifications for this automation.
always, on_failure, never IDs of files attached to the automation prompt. These files are provided as context to the agent on every run.