PATCH/hyax-api/v1/automations/:id

Update automation

Update name and/or description only. Graph edits use the dashboard UI.

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

Request body

Field	Required	Description
name	No	1–200 characters
description	No	String or null to clear

Request examples

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

curl -X PATCH 'https://platform.hyax.com/hyax-api/v1/automations/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Welcome flow",
    "description": "Updated description"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "name": "Welcome flow",
    "description": "Updated description",
    "status": "DRAFT",
    "updatedAt": "2025-01-20T09:00:00.000Z"
  }
}