Save an automation
const url = 'https://api.pixonaut.app/v1/automations/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"body":{"steps":[{"id":"approve","settings":{},"type":"approve"},{"branches":{"onFailure":[{"id":"tell","settings":{"role":"admin"},"type":"notify"}]},"id":"print","settings":{},"type":"create_print"}]},"expectedUpdatedAt":1760000400000,"name":"Hosted link to printshop","runsAs":"author","sources":{"includeNewKeys":true,"includeNewLinks":true,"includeNewStores":true,"keys":null,"links":null,"stores":null},"spendLimit":50,"trigger":"design.committed"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.pixonaut.app/v1/automations/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "body": { "steps": [ { "id": "approve", "settings": {}, "type": "approve" }, { "branches": { "onFailure": [ { "id": "tell", "settings": { "role": "admin" }, "type": "notify" } ] }, "id": "print", "settings": {}, "type": "create_print" } ] }, "expectedUpdatedAt": 1760000400000, "name": "Hosted link to printshop", "runsAs": "author", "sources": { "includeNewKeys": true, "includeNewLinks": true, "includeNewStores": true, "keys": null, "links": null, "stores": null }, "spendLimit": 50, "trigger": "design.committed" }'Operation ID: automations.save
The whole draft, stored as its next version. A save since expectedUpdatedAt is refused automation_changed. The saver becomes its author, unless it runs as the workspace; only an admin may save one that does, or set it to. An MCP key saves only a disabled one.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
The automation’s tree of steps.
object
object
Every one holds.
object
At least one holds.
object
It does not hold.
object
The fact compared.
It holds when the fact is one of these: each at most 200 characters, or 2054 for an origin, which may name a store’s site.
object
It holds from this many copies up.
It holds up to this many copies.
The order’s quantity.
object
The order’s delivery address.
Whether it must be set, or must not.
The steps, in the order they run. A step’s type names an action from the catalogue.
object
Further steps, under each branch’s name.
object
Its id, unique in the body: what a firing names it by.
What its type takes; the draft check refuses settings the type does not.
object
Its action (approve, create_print, place_order, reroute, cancel_order, notify, email, webhook) or flow step (only_if, paths, wait_for, delay).
Confirms that the automation spends without a person, at most its spend limit in 24 hours. Required, true, when it holds a spend action (create print, place order, reroute); a save without it is refused spend_unconfirmed.
Save only while it is disabled: an enabled one is refused automation_enabled and left as it is.
The updatedAt the draft was read at. A save since is refused automation_changed, naming who saved it and when.
What members call it.
author: it acts with the grants of the member who last saved it. workspace: it acts as the workspace, tied to no member; only an admin may set it, and an automation made with a secret key always runs so.
The sources it acts on: the studio always; designer links, keys and connected stores, each every one or a snapshot. To act on only some, an Only if compares the design’s origin.
object
On, it acts on designs from every secret and publishable key no store was given, those added later too. Off, only from those in keys.
On, it acts on designs from every designer link, those made later too. Off, only from the links in links.
On, it acts on designs from every connected store, those connected later too. Off, only from those in stores. A store may have its own automated flows on its designs; if it does, the first to move one on wins.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
Spend actions it may take per rolling 24 hours.
The event it fires on; null for none yet, which fires on nothing. One with none cannot be enabled.
Examples
Example
{ "body": { "steps": [ { "id": "approve", "settings": {}, "type": "approve" }, { "branches": { "onFailure": [ { "id": "tell", "settings": { "role": "admin" }, "type": "notify" } ] }, "id": "print", "settings": {}, "type": "create_print" } ] }, "expectedUpdatedAt": 1760000400000, "name": "Hosted link to printshop", "runsAs": "author", "sources": { "includeNewKeys": true, "includeNewLinks": true, "includeNewStores": true, "keys": null, "links": null, "stores": null }, "spendLimit": 50, "trigger": "design.committed"}Responses
Section titled “Responses”The automation as saved
object
The member whose grants it acts with: whoever last saved it. Null when it runs as the workspace.
object
The automation’s tree of steps.
object
object
Every one holds.
object
At least one holds.
object
It does not hold.
object
The fact compared.
It holds when the fact is one of these: each at most 200 characters, or 2054 for an origin, which may name a store’s site.
object
It holds from this many copies up.
It holds up to this many copies.
The order’s quantity.
object
The order’s delivery address.
Whether it must be set, or must not.
The steps, in the order they run. A step’s type names an action from the catalogue.
object
Further steps, under each branch’s name.
object
Its id, unique in the body: what a firing names it by.
What its type takes; the draft check refuses settings the type does not.
object
Its action (approve, create_print, place_order, reroute, cancel_order, notify, email, webhook) or flow step (only_if, paths, wait_for, delay).
When it was last enabled: it never fires on an event from before. Null for one never enabled.
object
Spend actions it took in the last 24 hours, against its spend limit.
The sources it acts on: the studio always; designer links, keys and connected stores, each every one or a snapshot. To act on only some, an Only if compares the design’s origin.
object
On, it acts on designs from every secret and publishable key no store was given, those added later too. Off, only from those in keys.
On, it acts on designs from every designer link, those made later too. Off, only from the links in links.
On, it acts on designs from every connected store, those connected later too. Off, only from those in stores. A store may have its own automated flows on its designs; if it does, the first to move one on wins.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
While its switch is off, those that existed when it was switched off; null while it is on. A save that turns it off with none takes it then.
object
Each one that existed then, as a design’s origin names it: link:<id>, secret_key:<id> and publishable_key:<id>, or store:<site>.
When its switch was turned off: the snapshot is as of then.
The event it fires on; null for none yet.
When it was last saved: a save names it as expectedUpdatedAt.
Its current version.
Examples
Example
{ "author": { "name": "Ada Lewis", "userId": "u_8b1d2c3e4f5a" }, "body": { "steps": [ { "id": "approve", "settings": {}, "type": "approve" }, { "branches": { "onFailure": [ { "id": "tell", "settings": { "role": "admin" }, "type": "notify" } ] }, "id": "print", "settings": {}, "type": "create_print" } ] }, "createdAt": 1760000000000, "enabled": true, "enabledAt": 1760000500000, "firings": { "count": 42, "lastAt": 1760086400000, "paused": 0, "spentToday": 3, "waiting": 2 }, "id": "aut_3c9e1f7a-2b4d-4e8a-9f6c-1d2e3f4a5b6c", "name": "Hosted link to printshop", "runsAs": "author", "sources": { "includeNewKeys": true, "includeNewLinks": true, "includeNewStores": true, "keys": null, "links": null, "stores": null }, "spendLimit": 50, "standing": { "state": "enabled" }, "trigger": "design.committed", "updatedAt": 1760090000000, "version": 4}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: invalid_body
object
Always sent with invalid_body.
Examples
invalid_body
{ "error": "invalid_body", "fields": [ "string" ]}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: feature_disabled, admin_only, origin_forbidden, forbidden
object
The feature the tenant does not have. Always sent with feature_disabled.
Always sent with admin_only.
Examples
admin_only
{ "error": "admin_only", "reason": "string"}feature_disabled
{ "error": "feature_disabled", "feature": "api"}forbidden
{ "error": "forbidden"}origin_forbidden
{ "error": "origin_forbidden"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: automation_not_found
object
Examples
automation_not_found
{ "error": "automation_not_found"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: automation_changed, automation_no_trigger, automation_enabled
object
Examples
automation_changed
{ "error": "automation_changed", "savedAt": 0, "savedBy": { "kind": "member", "name": "string", "userId": "string" }}automation_enabled
{ "error": "automation_enabled", "reason": "string"}automation_no_trigger
{ "error": "automation_no_trigger", "reason": "string"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: author_needs_member, draft_refused, spend_unconfirmed, spend_limit_over_ceiling, payload_too_large
object
Sent with payload_too_large.
The workspace’s ceiling, the most a spend limit may say. Always sent with spend_limit_over_ceiling.
Always sent with payload_too_large.
Always sent with author_needs_member, spend_unconfirmed, spend_limit_over_ceiling.
Always sent with draft_refused.
object
What is wrong, in words.
The step it is about.
Examples
author_needs_member
{ "error": "author_needs_member", "reason": "string"}draft_refused
{ "error": "draft_refused", "refusals": [ { "code": "unknown_action", "message": "string" } ]}payload_too_large
{ "error": "payload_too_large", "maxBytes": 0}spend_limit_over_ceiling
{ "ceiling": 0, "error": "spend_limit_over_ceiling", "reason": "string"}spend_unconfirmed
{ "error": "spend_unconfirmed", "reason": "string"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].