POST/hyax-api/v1/automations

Create automation

Creates a DRAFT automation with a default TRIGGER node.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request body

Field	Required	Description
name	Yes	1–200 characters
description	No	Optional, max 1000 characters
creatorId	No	Team member user ID; defaults to team creator

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X POST 'https://platform.hyax.com/hyax-api/v1/automations' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Welcome series",
    "description": "On signup"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "name": "Welcome series",
    "description": "On signup",
    "status": "DRAFT",
    "creatorId": "usr…",
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-15T12:00:00.000Z"
  }
}