Automations

Update an automation definition

patch/automations/{id}

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/automations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
folderstring nullable

Move it to this folder, matched by name (any case) and created when it does not exist. null or an empty string takes it out of any folder.

Example request

{
  "trigger": {
    "event": "user.created"
  }
}

Response

Updated automation

warningsstring[]

Returned on create and update when a step saves but should not ship as written — for example a product email whose body has no {{unsubscribe_url}} link.

Example response

{
  "automation": {
    "trigger": {
      "event": "user.created"
    }
  }
}

Changes

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