Enable, disable, or reconfigure an automation template

curl --request PATCH \
  --url https://api.royalti.io/ai/automations/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'

{
  "status": "success",
  "message": "<string>",
  "data": {
    "automation": {
      "template_id": "catalog-hygiene",
      "name": "<string>",
      "description": "<string>",
      "available": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enabled": true,
      "trigger": {
        "kind": "manual"
      },
      "config": {},
      "allowed_trigger_kinds": [
        "manual"
      ],
      "updated_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z",
      "last_run": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "TenantId": 123,
        "tenant_automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "template_id": "catalog-hygiene",
        "template_version": "<string>",
        "mastra_run_id": "<string>",
        "status": "queued",
        "trigger_source": "manual:user",
        "triggered_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "idempotency_key": "<string>",
        "config_snapshot": {},
        "approved_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "approved_at": "2023-11-07T05:31:56Z",
        "approval_decision": "approved",
        "awaiting_since": "2023-11-07T05:31:56Z",
        "result_summary": "<string>",
        "error": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "finished_at": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "FEATURE_REQUIRED",
  "data": null
}

{
  "status": "error",
  "message": "<string>",
  "code": "FEATURE_REQUIRED",
  "data": null
}

PATCH

automations

{templateId}

curl --request PATCH \
  --url https://api.royalti.io/ai/automations/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'

{
  "status": "success",
  "message": "<string>",
  "data": {
    "automation": {
      "template_id": "catalog-hygiene",
      "name": "<string>",
      "description": "<string>",
      "available": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enabled": true,
      "trigger": {
        "kind": "manual"
      },
      "config": {},
      "allowed_trigger_kinds": [
        "manual"
      ],
      "updated_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z",
      "last_run": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "TenantId": 123,
        "tenant_automation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "template_id": "catalog-hygiene",
        "template_version": "<string>",
        "mastra_run_id": "<string>",
        "status": "queued",
        "trigger_source": "manual:user",
        "triggered_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "idempotency_key": "<string>",
        "config_snapshot": {},
        "approved_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "approved_at": "2023-11-07T05:31:56Z",
        "approval_decision": "approved",
        "awaiting_since": "2023-11-07T05:31:56Z",
        "result_summary": "<string>",
        "error": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "finished_at": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "FEATURE_REQUIRED",
  "data": null
}

{
  "status": "error",
  "message": "<string>",
  "code": "FEATURE_REQUIRED",
  "data": null
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PATCH /ai/automations/ One upsert against the unique (TenantId, template_id) index — there is no separate enable/disable endpoint. Setting enabled: true on a template whose workflow has not shipped yet (available: false) is refused with TEMPLATE_NOT_AVAILABLE (409). Plan gate: setting trigger.kind to anything other than manual requires the automationsTriggers entitlement (PLUS and above) — refused with FEATURE_REQUIRED (403) on FREE and STARTER. enabled and config changes (and a trigger patch that keeps kind: manual) are ungated and available on every tier. The gate is enforced both here (route middleware, conditional on the body) and again inside AutomationService.configure, since agent/tool callers reach the service without passing through this route. Authorization: any authenticated tenant member.

Code Examples

const response = await fetch('https://api.royalti.io/ai/automations/example-id', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/AutomationPatch"
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.patch(
  'https://api.royalti.io/ai/automations/example-id',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/AutomationPatch"}
)

data = response.json()
print(data)

curl -X PATCH https://api.royalti.io/ai/automations/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/AutomationPatch"}'

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

templateId

enum<string>

required

Available options:

statement-notify-artists,

royalty-file-anomaly-hold,

catalog-hygiene,

release-delivery

Body

application/json

Every field optional — send only what changed. At least one is required.

enabled

boolean

trigger

object

Show child attributes

Example:

{ "kind": "manual" }

config

object

Response

Automation updated

status

string

Example:

"success"

message

string

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples