Skip to main content
POST
/
automations
Create an automation
curl --request POST \
  --url https://api.sendrealm.com/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "definition": {},
  "editor_layout": {}
}
'
{
  "status": 123,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": null
  }
}

​
Endpoints

  • GET /automations
  • POST /automations

​
Create request

{
  "name": "Post Purchase Journey",
  "description": "Follow up after a completed order.",
  "definition": {
    "trigger": {
      "event_name": "order.completed"
    },
    "steps": [
      {
        "key": "send_receipt",
        "type": "send_email_template",
        "config": {
          "template_version_id": "tpl_ver_email_123",
          "domain_id": "dom_123"
        }
      }
    ],
    "connections": [
      {
        "from": "trigger",
        "to": "send_receipt",
        "branch": "next"
      }
    ]
  },
  "editor_layout": {
    "viewport": {
      "x": 0,
      "y": 0,
      "zoom": 1
    },
    "nodes": [
      {
        "id": "trigger",
        "position": {
          "x": 120,
          "y": 180
        }
      }
    ]
  }
}

​
List filters

GET /automations?status=active&search=post

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
​
description
string | null
​
definition
object
​
editor_layout
object

Response

Automation created