Added simplified edit endpoint for automations (TryGhost#27853)

cmraible · web-flow · commit fe9dfb30bb94 · 2026-05-12T23:28:54.000Z
closes https://linear.app/ghost/issue/NY-1281/create-endpoint-for-editing-automations-status ## Summary This adds a `PUT automations/:id` endpoint for editing automations. Right now this endpoint can _only_ edit the status of the automation — any other fields or relations passed are ignored. We'll soon extend this endpoint to allow editing other fields on the automation (e.g. name) and the automation's actions/edges.
diff --git a/ghost/core/core/server/api/endpoints/automations.js b/ghost/core/core/server/api/endpoints/automations.js
@@ -1,5 +1,13 @@
+const errors = require('@tryghost/errors');
 const automationsApi = require('../../services/automations/automations-api');
 
+const VALID_AUTOMATION_STATUSES = ['active', 'inactive'];
+
+const messages = {
+    invalidAutomationStatus: 'Automation status must be one of: active, inactive.',
+    invalidAutomationStatusHelp: 'Use "active" or "inactive" for automation status.'
+};
+
 /** @type {import('@tryghost/api-framework').Controller} */
 const controller = {
     docName: 'automations',
@@ -27,6 +35,31 @@ const controller = {
         }
     },
 
+    edit: {
+        headers: {
+            cacheInvalidate: false
+        },
+        options: [
+            'id'
+        ],
+        validation(frame) {
+            const status = frame.data?.automations?.[0]?.status;
+
+            if (!VALID_AUTOMATION_STATUSES.includes(status)) {
+                throw new errors.ValidationError({
+                    message: messages.invalidAutomationStatus,
+                    context: status === undefined ? undefined : `Received status "${status}".`,
+                    help: messages.invalidAutomationStatusHelp,
+                    property: 'status'
+                });
+            }
+        },
+        permissions: true,
+        async query(frame) {
+            return await automationsApi.edit(frame.options.id, frame.data.automations[0]);
+        }
+    },
+
     poll: {
         statusCode: 204,
         headers: {
diff --git a/ghost/core/core/server/services/automations/automations-api.ts b/ghost/core/core/server/services/automations/automations-api.ts
@@ -12,6 +12,10 @@ const messages = {
     automationNotFound: 'Automation not found.'
 };
 
+interface EditAutomationData {
+    status: string;
+}
+
 let testDatabase: DatabaseSync | null = null;
 
 const repository = createFakeDatabaseAutomationsRepository({
@@ -40,12 +44,28 @@ async function read(automationId: string) {
     return automation;
 }
 
+async function edit(automationId: string, data: EditAutomationData) {
+    // TODO (NY-1229): Allow updating other fields and actions/edges.
+    const automation = await repository.edit(automationId, {
+        status: data.status
+    });
+
+    if (!automation) {
+        throw new errors.NotFoundError({
+            message: tpl(messages.automationNotFound)
+        });
+    }
+
+    return automation;
+}
+
 function requestPoll() {
     domainEvents.dispatch(StartAutomationsPollEvent.create());
 }
 
 module.exports = {
     browse,
+    edit,
     read,
     requestPoll
 };
diff --git a/ghost/core/core/server/services/automations/automations-repository.ts b/ghost/core/core/server/services/automations/automations-repository.ts
@@ -59,4 +59,5 @@ export interface Automation extends AutomationSummary {
 export interface AutomationsRepository {
     browse(): Promise<Page<AutomationSummary>>;
     getById(id: string): Promise<Automation | null>;
+    edit(id: string, data: Pick<AutomationSummary, 'status'>): Promise<Automation | null>;
 }
diff --git a/ghost/core/core/server/services/automations/fake-database-automations-repository.ts b/ghost/core/core/server/services/automations/fake-database-automations-repository.ts
@@ -72,6 +72,27 @@ export function createFakeDatabaseAutomationsRepository({
 
                 return buildAutomation(database, automation);
             });
+        },
+
+        async edit(id: string, data: Pick<AutomationSummary, 'status'>): Promise<Automation | null> {
+            const database = getDatabase();
+
+            return withTransaction(database, () => {
+                const automation = loadAutomation(database, id);
+
+                if (!automation) {
+                    return null;
+                }
+
+                // TODO (NY-1229): Allow updating other fields and actions/edges.
+                const updatedAutomation = updateAutomation(database, {
+                    ...automation,
+                    status: data.status,
+                    updated_at: new Date().toISOString()
+                });
+
+                return buildAutomation(database, updatedAutomation);
+            });
         }
     };
 }
@@ -107,6 +128,31 @@ function loadAutomations(database: DatabaseSync): AutomationRow[] {
     `).all() as unknown as AutomationRow[];
 }
 
+function updateAutomation(database: DatabaseSync, automation: AutomationRow): AutomationRow {
+    database.prepare(`
+        UPDATE automations
+        SET status = :status,
+            updated_at = :updated_at
+        WHERE id = :id
+    `).run({
+        id: automation.id,
+        status: automation.status,
+        updated_at: automation.updated_at
+    });
+
+    return requireAutomation(loadAutomation(database, automation.id), automation.id);
+}
+
+function requireAutomation(automation: AutomationRow | null, id: string): AutomationRow {
+    if (!automation) {
+        throw new errors.InternalServerError({
+            message: `Updated automation "${id}" could not be loaded.`
+        });
+    }
+
+    return automation;
+}
+
 function buildAutomation(database: DatabaseSync, automation: AutomationRow): Automation {
     return {
         ...buildAutomationSummary(automation),
diff --git a/ghost/core/core/server/web/api/endpoints/admin/routes.js b/ghost/core/core/server/web/api/endpoints/admin/routes.js
@@ -189,6 +189,7 @@ module.exports = function apiRoutes() {
     router.get('/automations', mw.authAdminApi, http(api.automations.browse));
     router.get('/automations/:id', mw.authAdminApi, http(api.automations.read));
     router.put('/automations/poll', mw.authAdminApiWithUrl, http(api.automations.poll));
+    router.put('/automations/:id', mw.authAdminApi, http(api.automations.edit));
 
     // ## Automated Emails
     router.get('/automated_emails', mw.authAdminApi, http(api.automatedEmails.browse));
diff --git a/ghost/core/test/e2e-api/admin/__snapshots__/automations.test.js.snap b/ghost/core/test/e2e-api/admin/__snapshots__/automations.test.js.snap
@@ -46,6 +46,150 @@ Object {
 }
 `;
 
+exports[`Automations API edit edits automation status, ignoring name, actions and edges 1: [body] 1`] = `
+Object {
+  "automations": Array [
+    Object {
+      "actions": Array [
+        Object {
+          "data": Object {
+            "wait_hours": 48,
+          },
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "type": "wait",
+        },
+        Object {
+          "data": Object {
+            "email_design_setting_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+            "email_lexical": "{\\"root\\":{\\"children\\":[{\\"type\\":\\"paragraph\\",\\"children\\":[{\\"type\\":\\"text\\",\\"text\\":\\"Lorem ipsum.\\"}]}],\\"direction\\":null,\\"format\\":\\"\\",\\"indent\\":0,\\"type\\":\\"root\\",\\"version\\":1}}",
+            "email_sender_email": null,
+            "email_sender_name": null,
+            "email_sender_reply_to": null,
+            "email_subject": "Welcome!",
+          },
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "type": "send_email",
+        },
+        Object {
+          "data": Object {
+            "wait_hours": 72,
+          },
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "type": "wait",
+        },
+        Object {
+          "data": Object {
+            "email_design_setting_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+            "email_lexical": "{\\"root\\":{\\"children\\":[{\\"type\\":\\"paragraph\\",\\"children\\":[{\\"type\\":\\"text\\",\\"text\\":\\"Lorem ipsum.\\"}]}],\\"direction\\":null,\\"format\\":\\"\\",\\"indent\\":0,\\"type\\":\\"root\\",\\"version\\":1}}",
+            "email_sender_email": null,
+            "email_sender_name": null,
+            "email_sender_reply_to": null,
+            "email_subject": "Follow up",
+          },
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "type": "send_email",
+        },
+      ],
+      "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+      "edges": Array [
+        Object {
+          "source_action_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "target_action_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+        },
+        Object {
+          "source_action_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "target_action_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+        },
+        Object {
+          "source_action_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "target_action_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+        },
+      ],
+      "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+      "name": "Welcome Email (Free)",
+      "slug": "member-welcome-email-free",
+      "status": "inactive",
+      "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+    },
+  ],
+}
+`;
+
+exports[`Automations API edit edits automation status, ignoring name, actions and edges 2: [headers] 1`] = `
+Object {
+  "access-control-allow-origin": "http://127.0.0.1:2369",
+  "cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
+  "content-length": StringMatching /\\\\d\\+/,
+  "content-type": "application/json; charset=utf-8",
+  "content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
+  "etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
+  "vary": "Accept-Version, Origin, Accept-Encoding",
+  "x-powered-by": "Express",
+}
+`;
+
+exports[`Automations API edit rejects a missing automation status 1: [body] 1`] = `
+Object {
+  "errors": Array [
+    Object {
+      "code": null,
+      "context": "Automation status must be one of: active, inactive.",
+      "details": null,
+      "ghostErrorCode": null,
+      "help": "Use \\"active\\" or \\"inactive\\" for automation status.",
+      "id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
+      "message": "Validation error, cannot edit automation.",
+      "property": "status",
+      "type": "ValidationError",
+    },
+  ],
+}
+`;
+
+exports[`Automations API edit rejects a missing automation status 2: [headers] 1`] = `
+Object {
+  "access-control-allow-origin": "http://127.0.0.1:2369",
+  "cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
+  "content-length": "333",
+  "content-type": "application/json; charset=utf-8",
+  "content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
+  "etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
+  "vary": "Accept-Version, Origin, Accept-Encoding",
+  "x-powered-by": "Express",
+}
+`;
+
+exports[`Automations API edit rejects an invalid automation status 1: [body] 1`] = `
+Object {
+  "errors": Array [
+    Object {
+      "code": null,
+      "context": "Automation status must be one of: active, inactive. Received status \\"paused\\".",
+      "details": null,
+      "ghostErrorCode": null,
+      "help": "Use \\"active\\" or \\"inactive\\" for automation status.",
+      "id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
+      "message": "Validation error, cannot edit automation.",
+      "property": "status",
+      "type": "ValidationError",
+    },
+  ],
+}
+`;
+
+exports[`Automations API edit rejects an invalid automation status 2: [headers] 1`] = `
+Object {
+  "access-control-allow-origin": "http://127.0.0.1:2369",
+  "cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
+  "content-length": "361",
+  "content-type": "application/json; charset=utf-8",
+  "content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
+  "etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
+  "vary": "Accept-Version, Origin, Accept-Encoding",
+  "x-powered-by": "Express",
+}
+`;
+
 exports[`Automations API poll does not poll when request lacks a token 1: [body] 1`] = `
 Object {
   "errors": Array [
diff --git a/ghost/core/test/e2e-api/admin/automations.test.js b/ghost/core/test/e2e-api/admin/automations.test.js

Original file line number	Diff line number	Diff line change
`@@ -59,4 +59,5 @@ export interface Automation extends AutomationSummary {`
`59`	`59`	`export interface AutomationsRepository {`
`60`	`60`	`browse(): Promise<Page<AutomationSummary>>;`
`61`	`61`	`getById(id: string): Promise<Automation \| null>;`
	`62`	`+ edit(id: string, data: Pick<AutomationSummary, 'status'>): Promise<Automation \| null>;`
`62`	`63`	`}`