v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

AI Routines

Update a routine

Update a routine. All request fields are optional, and only supplied fields are changed. Supplying destination replaces the full recipient configuration.

patch/api/v1/ai/routines/{id}

Path parameters

idstring uuid required

The UUID of the routine.

Query parameters

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Request body

descriptionstring nullable

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

namestring

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

promptstring

New natural language prompt Omni runs on each scheduled run.

schedulestring

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.

timezonestring

New IANA timezone identifier used to evaluate the schedule.

Example request

{
  "destination": {
    "recipientEmails": [
      "alice@example.com",
      "bob@example.com"
    ],
    "type": "email",
    "userGroupIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  }
}

Response

Updated routine details.

branchIdstring uuid nullable required

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

createdAtstring required

ISO 8601 timestamp when the routine was created.

descriptionstring nullable required

Display-only notes about the routine, or null.

disabledboolean required

Whether the owner has paused the routine.

idstring uuid required

The unique identifier of the routine.

modelIdstring uuid required

The model the prompt runs against.

namestring required

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

promptstring required

Natural language prompt Omni runs on each scheduled run.

recipientCountinteger required

Number of distinct deliverable recipients. For email, user groups are expanded to members and duplicates removed; a Slack routine is always 1 (its single channel or DM).

schedulestring required

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

systemDisabledboolean required

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

systemDisabledReasonstring nullable required

Reason Omni disabled the routine, or null.

timezonestring required

IANA timezone identifier used to evaluate the schedule.

topicNamestring nullable required

Topic scoping query generation, or null.

updatedAtstring required

ISO 8601 timestamp when the routine was last updated.

Example response

{
  "destination": {
    "recipientEmails": [
      "alice@example.com",
      "bob@example.com"
    ],
    "type": "email",
    "userGroupIds": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  },
  "lastRun": {
    "label": "Delivered",
    "state": "COMPLETE"
  }
}