Automations

Create a draft automation

post/automations

Request

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

Request body

namestring required
folderstring

Folder to file it in on the dashboard, matched by name (any case) and created when it does not exist.

Example request

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

Response

Automation created as draft

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.