Skip to main content
POST
/
v3
/
automations
Add an automation
curl --request POST \
  --url http://localhost/api/v3/automations \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "date",
  "query": "<string>",
  "query_type": "<string>",
  "date": "2023-12-25",
  "slot": "AU-MEL-0",
  "description": "<string>",
  "is_active": true,
  "notes": "<string>",
  "frequency": "monthly",
  "run_at": 123,
  "arguments": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "actions": [
    {
      "name": "<string>",
      "sort_order": 123,
      "uuid": "<string>",
      "arguments": [
        {
          "name": "<string>",
          "value": "<string>",
          "is_dynamic": true
        }
      ],
      "description": "<string>",
      "notes": "<string>"
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "type": "<string>",
    "query": "<string>",
    "query_type": "<string>",
    "date": "<string>",
    "arguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "slot": "<string>",
    "actions": [
      {
        "id": 123,
        "uuid": "<string>",
        "references_id": "<string>",
        "name": "<string>",
        "sort_order": 123,
        "description": "<string>",
        "notes": "<string>",
        "arguments": [
          {
            "name": "<string>",
            "value": "<string>",
            "is_dynamic": "<string>"
          }
        ],
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "description": "<string>",
    "notes": "<string>",
    "is_active": true,
    "frequency": "<string>",
    "run_at": 123,
    "last_run_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
name
string
required
type
enum<string>
required
Available options:
date,
scheduled
query
string
required
query_type
string | null
date
string<date>
slot
enum<string>
Available options:
AU-MEL-0,
AU-MEL-1,
AU-MEL-2,
AU-MEL-3,
AU-MEL-4,
AU-MEL-5,
AU-MEL-6,
AU-MEL-7,
AU-MEL-8,
AU-MEL-9,
AU-MEL-10,
AU-MEL-11,
AU-MEL-12,
AU-MEL-13,
AU-MEL-14,
AU-MEL-15,
AU-MEL-16,
AU-MEL-17,
AU-MEL-18,
AU-MEL-19,
AU-MEL-20,
AU-MEL-21,
AU-MEL-22,
AU-MEL-23,
NZ-AUK-1,
AU-MEL-HOURLY-0
description
string | null
is_active
boolean | null
notes
string | null
frequency
enum<string> | null
Available options:
monthly,
weekly,
fortnightly,
daily
run_at
integer | null
arguments
object[] | null
actions
object[]
Minimum array length: 1

Response

Automation

data
Automation · object
required