← Documentation home
POST/hyax-api/v1/automations/:id/toggle

Toggle automation

Activate or pause. Omit `action` to toggle: ACTIVE → PAUSED; otherwise activate (validates graph).

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

Request body

FieldRequiredDescription
actionNo`activate` | `pause` (optional)

Request examples

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

curl -X POST 'https://platform.hyax.com/hyax-api/v1/automations/clx_example_id/toggle' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "activate"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": { "id": "clx…", "status": "ACTIVE", "action": "activate" }
}