Turn an automation on
From now on its trigger lets people in, with its saved version. 409 `never_saved` before its first save; 422 `checks_failed` when the saved version has problems.
From now on its trigger lets people in, with its saved version. 409 never_saved before its first save; 422 checks_failed when the saved version has problems.
apiKey writeAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: write
id*string^(auto)_[0-9A-Za-z]{8}$idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
1 <= length <= 255OK
application/json- response
id*string^(tmpl|comp|brand|otype|seg|trait|camp|auto)_[0-9A-Za-z]{8}$kind*stringname*stringfolder*|The folder it’s in; null at the top level
status*string"draft""published""archived"draftVersionId*stringuuidpublishedVersionId*|uuidhasUnpublishedChanges*booleancreatedAt*stringdate-timeupdatedAt*stringdate-timearchivedAt*|date-timetrigger*||state*draft*curl -X POST 'https://api.postforge.dev/v1/automations/string/turn-on'{ "id": "string", "kind": "string", "name": "string", "folder": { "id": "string", "name": "string" }, "status": "draft", "draftVersionId": "e7fc80a1-b65e-482e-8fcd-f6c647b4104b", "publishedVersionId": "9786f1b1-ef7e-4f6a-94c4-c8eb67e924eb", "hasUnpublishedChanges": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z", "trigger": { "type": "event", "event": "string", "where": { "type": "and", "conditions": [ null ] } }, "state": { "status": "on", "changedAt": "2019-08-24T14:15:22Z", "active": 0, "unsavedChanges": true }, "draft": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "definitionId": "string", "parentVersionId": "abf80970-9686-419e-bc00-5ddcccc33ba6", "origin": "edit", "schemaVersion": 0, "author": { "type": "user", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "createdAt": "2019-08-24T14:15:22Z", "openedAt": "2019-08-24T14:15:22Z", "definition": { "trigger": { "type": "event", "event": "string", "where": { "type": "and", "conditions": [ null ] } }, "entry": { "who": { "type": "and", "conditions": [ null ] }, "again": { "type": "always" }, "whileIn": "restart" }, "steps": [ { "id": "string", "type": "wait", "wait": { "amount": 1, "unit": "minutes" } } ] } }}Discard an automation’s unsaved changes POST
Puts its draft back to the version in use. 409 `nothing_to_save` when there are no unsaved changes; 409 `never_saved` for an automation never saved (archive it instead).
Turn an automation off POST
Nobody enters any more, and everyone in it leaves (`turned_off`): nothing more is sent to them from it.