Update an AI Routine

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/ai/routines/{routineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "condition": {
    "conditionPrompt": "there are failed orders"
  },
  "name": "<string>",
  "description": "<string>",
  "destination": {
    "type": "email",
    "recipientEmails": [
      "blob.ross@blobsrus.com",
      "blob.the.builder@blobsrus.com"
    ],
    "userGroupIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  },
  "prompt": "<string>",
  "schedule": "<string>",
  "timezone": "<string>"
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}"

payload = {
    "condition": { "conditionPrompt": "there are failed orders" },
    "name": "<string>",
    "description": "<string>",
    "destination": {
        "type": "email",
        "recipientEmails": ["blob.ross@blobsrus.com", "blob.the.builder@blobsrus.com"],
        "userGroupIds": ["550e8400-e29b-41d4-a716-446655440000"]
    },
    "prompt": "<string>",
    "schedule": "<string>",
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    condition: {conditionPrompt: 'there are failed orders'},
    name: '<string>',
    description: '<string>',
    destination: {
      type: 'email',
      recipientEmails: ['blob.ross@blobsrus.com', 'blob.the.builder@blobsrus.com'],
      userGroupIds: ['550e8400-e29b-41d4-a716-446655440000']
    },
    prompt: '<string>',
    schedule: '<string>',
    timezone: '<string>'
  })
};

fetch('https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'condition' => [
        'conditionPrompt' => 'there are failed orders'
    ],
    'name' => '<string>',
    'description' => '<string>',
    'destination' => [
        'type' => 'email',
        'recipientEmails' => [
                'blob.ross@blobsrus.com',
                'blob.the.builder@blobsrus.com'
        ],
        'userGroupIds' => [
                '550e8400-e29b-41d4-a716-446655440000'
        ]
    ],
    'prompt' => '<string>',
    'schedule' => '<string>',
    'timezone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}"

	payload := strings.NewReader("{\n  \"condition\": {\n    \"conditionPrompt\": \"there are failed orders\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"destination\": {\n    \"type\": \"email\",\n    \"recipientEmails\": [\n      \"blob.ross@blobsrus.com\",\n      \"blob.the.builder@blobsrus.com\"\n    ],\n    \"userGroupIds\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ]\n  },\n  \"prompt\": \"<string>\",\n  \"schedule\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"condition\": {\n    \"conditionPrompt\": \"there are failed orders\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"destination\": {\n    \"type\": \"email\",\n    \"recipientEmails\": [\n      \"blob.ross@blobsrus.com\",\n      \"blob.the.builder@blobsrus.com\"\n    ],\n    \"userGroupIds\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ]\n  },\n  \"prompt\": \"<string>\",\n  \"schedule\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"condition\": {\n    \"conditionPrompt\": \"there are failed orders\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"destination\": {\n    \"type\": \"email\",\n    \"recipientEmails\": [\n      \"blob.ross@blobsrus.com\",\n      \"blob.the.builder@blobsrus.com\"\n    ],\n    \"userGroupIds\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ]\n  },\n  \"prompt\": \"<string>\",\n  \"schedule\": \"<string>\",\n  \"timezone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "condition": {
    "conditionPrompt": "there are failed orders",
    "conditionType": "RESULTS_PRESENT"
  },
  "createdAt": "<string>",
  "description": "<string>",
  "destination": {
    "type": "email",
    "recipientEmails": [
      "blob.ross@blobsrus.com",
      "blob.the.builder@blobsrus.com"
    ],
    "userGroupIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  },
  "disabled": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastRun": {
    "completedAt": "<string>",
    "label": "Delivered",
    "state": "COMPLETE"
  },
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "prompt": "<string>",
  "recipientCount": 123,
  "schedule": "<string>",
  "systemDisabled": true,
  "systemDisabledReason": "<string>",
  "timezone": "<string>",
  "topicName": "<string>",
  "updatedAt": "<string>"
}

{
  "detail": "The delivery condition is too vague or subjective to evaluate. State a specific, measurable condition, then try again.",
  "status": 400,
  "code": "not_expressible"
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "code": "shutoff",
  "detail": "The AI credit limit has been reached. Contact your administrator for assistance.",
  "status": 402
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "detail": "Omni was temporarily unable to compose or verify the delivery condition. Try again shortly.",
  "status": 503
}

PUT

routines

{routineId}

Update an AI Routine

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/ai/routines/{routineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "condition": {
    "conditionPrompt": "there are failed orders"
  },
  "name": "<string>",
  "description": "<string>",
  "destination": {
    "type": "email",
    "recipientEmails": [
      "blob.ross@blobsrus.com",
      "blob.the.builder@blobsrus.com"
    ],
    "userGroupIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  },
  "prompt": "<string>",
  "schedule": "<string>",
  "timezone": "<string>"
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}"

payload = {
    "condition": { "conditionPrompt": "there are failed orders" },
    "name": "<string>",
    "description": "<string>",
    "destination": {
        "type": "email",
        "recipientEmails": ["blob.ross@blobsrus.com", "blob.the.builder@blobsrus.com"],
        "userGroupIds": ["550e8400-e29b-41d4-a716-446655440000"]
    },
    "prompt": "<string>",
    "schedule": "<string>",
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    condition: {conditionPrompt: 'there are failed orders'},
    name: '<string>',
    description: '<string>',
    destination: {
      type: 'email',
      recipientEmails: ['blob.ross@blobsrus.com', 'blob.the.builder@blobsrus.com'],
      userGroupIds: ['550e8400-e29b-41d4-a716-446655440000']
    },
    prompt: '<string>',
    schedule: '<string>',
    timezone: '<string>'
  })
};

fetch('https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'condition' => [
        'conditionPrompt' => 'there are failed orders'
    ],
    'name' => '<string>',
    'description' => '<string>',
    'destination' => [
        'type' => 'email',
        'recipientEmails' => [
                'blob.ross@blobsrus.com',
                'blob.the.builder@blobsrus.com'
        ],
        'userGroupIds' => [
                '550e8400-e29b-41d4-a716-446655440000'
        ]
    ],
    'prompt' => '<string>',
    'schedule' => '<string>',
    'timezone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}"

	payload := strings.NewReader("{\n  \"condition\": {\n    \"conditionPrompt\": \"there are failed orders\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"destination\": {\n    \"type\": \"email\",\n    \"recipientEmails\": [\n      \"blob.ross@blobsrus.com\",\n      \"blob.the.builder@blobsrus.com\"\n    ],\n    \"userGroupIds\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ]\n  },\n  \"prompt\": \"<string>\",\n  \"schedule\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"condition\": {\n    \"conditionPrompt\": \"there are failed orders\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"destination\": {\n    \"type\": \"email\",\n    \"recipientEmails\": [\n      \"blob.ross@blobsrus.com\",\n      \"blob.the.builder@blobsrus.com\"\n    ],\n    \"userGroupIds\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ]\n  },\n  \"prompt\": \"<string>\",\n  \"schedule\": \"<string>\",\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/ai/routines/{routineId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"condition\": {\n    \"conditionPrompt\": \"there are failed orders\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"destination\": {\n    \"type\": \"email\",\n    \"recipientEmails\": [\n      \"blob.ross@blobsrus.com\",\n      \"blob.the.builder@blobsrus.com\"\n    ],\n    \"userGroupIds\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ]\n  },\n  \"prompt\": \"<string>\",\n  \"schedule\": \"<string>\",\n  \"timezone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "condition": {
    "conditionPrompt": "there are failed orders",
    "conditionType": "RESULTS_PRESENT"
  },
  "createdAt": "<string>",
  "description": "<string>",
  "destination": {
    "type": "email",
    "recipientEmails": [
      "blob.ross@blobsrus.com",
      "blob.the.builder@blobsrus.com"
    ],
    "userGroupIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  },
  "disabled": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastRun": {
    "completedAt": "<string>",
    "label": "Delivered",
    "state": "COMPLETE"
  },
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "prompt": "<string>",
  "recipientCount": 123,
  "schedule": "<string>",
  "systemDisabled": true,
  "systemDisabledReason": "<string>",
  "timezone": "<string>",
  "topicName": "<string>",
  "updatedAt": "<string>"
}

{
  "detail": "The delivery condition is too vague or subjective to evaluate. State a specific, measurable condition, then try again.",
  "status": 400,
  "code": "not_expressible"
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "code": "shutoff",
  "detail": "The AI credit limit has been reached. Contact your administrator for assistance.",
  "status": 402
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "detail": "Omni was temporarily unable to compose or verify the delivery condition. Try again shortly.",
  "status": 503
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

routineId

string<uuid>

required

The UUID of the routine.

Query Parameters

userId

string<uuid>

Organization API key required. Target user membership ID.

Body

application/json

condition

object | null

Replaces the delivery condition: Omni authors and verifies the condition query, resets the comparison baseline, and cancels any in-progress condition evaluation so a run started under the old condition cannot deliver.

Pass null to remove the condition, making the routine deliver on every scheduled run.

Omit to leave the stored condition unchanged.

Show child attributes

name

string

New customer-visible name of the routine. Used as the email subject for email destinations, and shown on Slack deliveries.

Required string length: 1 - 512

description

string | null

Display-only notes about the routine. Pass null to clear it.

Maximum string length: 2000

destination

object

Replaces the routine's full recipient configuration with the supplied destination.

Option 1
Option 2

Show child attributes

prompt

string

New natural language prompt for the routine: what Omni runs and delivers on each scheduled run. Run a skill as part of the routine by including a skill's /identifier, which will resolve as the routine owner when the routine fires.

Minimum string length: 1

schedule

string

New six-field cron expression (minute, hour, day-of-month, month, day-of-week, year; use ? for an unspecified day field). Minimum frequency is once per hour.

Minimum string length: 1

timezone

string

New IANA timezone identifier used to evaluate the schedule.

Minimum string length: 1

Response

Routine updated successfully

branchId

string<uuid> | null

required

Branch of the shared model the prompt runs against, or null.

condition

object | null

required

The delivery condition. Null for a routine that delivers on every scheduled run.

Show child attributes

createdAt

string

required

ISO 8601 timestamp when the routine was created.

description

string | null

required

Display-only notes about the routine, or null.

destination

object

required

Single delivery destination for the routine — email or Slack. To send results to multiple destinations, create one routine per destination.

Option 1
Option 2

Show child attributes

disabled

boolean

required

Whether the owner has paused the routine.

string<uuid>

required

The unique identifier of the routine.

lastRun

object | null

required

Most recent completed run, or null if the routine has never completed a run.

Show child attributes

modelId

string<uuid>

required

The shared model the prompt runs against.

name

string

required

Customer-visible name of the routine, used as the email subject.

prompt

string

required

Natural language prompt Omni runs on each scheduled run.

recipientCount

integer

required

Number of distinct deliverable recipients after expanding user groups and removing duplicates.

schedule

string

required

Six-field cron expression (minute, hour, day-of-month, month, day-of-week, year; use ? for an unspecified day field).

systemDisabled

boolean

required

Whether Omni disabled the routine because it could no longer run successfully or safely.

systemDisabledReason

string | null

required

Reason Omni disabled the routine, or null.

timezone

string

required

IANA timezone identifier used to evaluate the schedule.

topicName

string | null

required

Topic scoping query generation, or null.

updatedAt

string

required

ISO 8601 timestamp when the routine was last updated.

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Update an AI Routine

Authorizations

Path Parameters

Query Parameters

Body

Response