Agent Builder

Update agent schedule

Updates an organization-owned Agent Builder schedule and returns safe schedule metadata.

PUTNeeds publication reviewLocal writeAgent BuilderoperationId: updateAgentBuilderSchedulehttps://dev-api.quickintell.com/api/v1/agent-builder/schedules/{scheduleId}

Needs publication reviewLocal writeAgent Builder and Prevention

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the agent builder and prevention contract generated for PUT /api/v1/agent-builder/schedules/{scheduleId}. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for PUT /api/v1/agent-builder/schedules/{scheduleId}, but keeps the route out of ordinary production API positioning until review is complete.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Agent Builder public API.

Agent Builder public API endpoints let an authenticated tenant integration manage visual robotic process automation (RPA) agent definitions, schedules, safe execution wrapper records, credential discovery metadata, and reusable templates. These endpoints are intentionally conservative: definition and schedule responses return safe metadata, template responses omit step bodies, credential responses omit stored usernames and secrets, and execution create/retry responses expose `dryRun`, `queueOnly`, and `browserAutomationStarted` safety controls instead of starting browser automation inline. Use these endpoints to configure and monitor organization-scoped automation around payer, electronic health record (EHR), clearinghouse, government, lab, pharmacy, registry, or custom portals. Do not send real protected health information (PHI), raw portal payloads, credentials, electronic data interchange (EDI) files, transcripts, or storage keys in examples or logs. Treat `inputParams`, `steps`, extraction schemas, schedule secrets, and execution output as sensitive workflow configuration. Public read endpoints require Agent Builder read access; public write endpoints require the relevant Agent Builder automation write/admin permission, role-based access control (RBAC), and organization ownership checks.

What this endpoint does

Use case

Use this to change trigger configuration, credentials, inputs, alert settings, dependencies, or active state for an existing schedule.

Before calling

Load the current schedule and decide whether changing trigger, cron expression, interval, or timezone should recompute `nextRunAt`.

Request and response behavior

Request guidance

Send only the fields you intend to change. Do not use schedule input parameters, webhook secrets, or alert emails to store PHI or credentials.

`name`, `cronExpression`, `intervalMinutes`, `blackoutWindows`, `eventTrigger`, `webhookSecret`, `inputParams`, `credentialId`, `deadlineMinutes`, and `dependsOnScheduleId` may be nullable according to the update schema.
`maxConcurrentRuns` remains constrained to 1-50, `maxRetries` to 0-10, `deadlineMinutes` to 1-10080, and `pauseAfterFailures` to 1-100.
Create/update schedule can accept a caller-provided `webhookSecret`, but only `rotateAgentBuilderScheduleWebhookSecret` generates and returns a display-once `webhookSecret`.

Response semantics

A 200 response returns `SAFE_WRITE_DB_ONLY` schedule metadata. Sensitive schedule configuration remains omitted from the response schema.

Response metadata confirms the visible schedule state only.
Secrets, alert email lists, runtime input parameters, retry settings, and blackout windows are not returned.

Errors and retries

Treat 404 as missing or wrong-tenant schedule. If an update timeout occurs, read the schedule before retrying to avoid overwriting concurrent admin changes.

400 can indicate invalid cron, missing dependency schedule, or invalid credential state.
403 means missing automation admin write permission.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

Name	Location	Required	Type	Description	Validation and safety notes
scheduleId	path	Yes	string	Path ID of the schedule to update.	Minimum length: 1.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

Name	Location	Required	Type	Description	Validation and safety notes
name	body	No	string	Optional replacement schedule name or null to clear where accepted, 1-200 characters.	Minimum length: 1. Maximum length: 200.
triggerType	body	No	CRON \| INTERVAL \| EVENT \| WEBHOOK \| MANUAL \| DEPENDENCY	Optional replacement trigger family.	Enum values are declared in the Type column.
cronExpression	body	No	string	Optional replacement cron expression or null; 1-120 characters when provided.	Minimum length: 1. Maximum length: 120.
intervalMinutes	body	No	integer	Optional replacement interval or null; 1-525600 minutes when provided.	Minimum value: 1. Maximum value: 525600.
timezone	body	No	string	Optional replacement timezone, 1-100 characters.	Minimum length: 1. Maximum length: 100.
blackoutWindows	body	No	object[]	Optional replacement blackout-window array or null; up to 50 entries.	OpenAPI does not declare additional validation metadata.
eventTrigger	body	No	string	Optional replacement event key or null, 1-200 characters.	Minimum length: 1. Maximum length: 200.
webhookSecret	body	No	string	Optional caller-provided replacement webhook secret or null, 16-512 characters; the response does not return it.	Minimum length: 16. Maximum length: 512. Sensitive credential or storage-adjacent value; use placeholders only.
inputParams	body	No	object	Optional replacement runtime input object or null; treat as sensitive.	OpenAPI does not declare additional validation metadata.
credentialId	body	No	string	Optional replacement credential ID or null to clear the link when accepted.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
maxConcurrentRuns	body	No	integer	Optional replacement concurrency cap, 1-50.	Minimum value: 1. Maximum value: 50.
retryOnFailure	body	No	boolean	Optional replacement retry-on-failure toggle.	OpenAPI does not declare additional validation metadata.
maxRetries	body	No	integer	Optional replacement maximum retry count, 0-10.	Minimum value: 0. Maximum value: 10.
priority	body	No	HIGH \| NORMAL \| LOW	Optional replacement run priority: `HIGH`, `NORMAL`, or `LOW`.	Enum values are declared in the Type column.
deadlineMinutes	body	No	integer	Optional replacement deadline window or null, 1-10080 minutes when provided.	Minimum value: 1. Maximum value: 10080.
alertOnFailure	body	No	boolean	Optional replacement failure-alert toggle.	OpenAPI does not declare additional validation metadata.
alertEmails	body	No	string (email)[]	Optional replacement alert recipient list, up to 50 email addresses.	Potential PHI; use synthetic examples and avoid logging raw values.
pauseAfterFailures	body	No	integer	Optional replacement consecutive failure threshold, 1-100.	Minimum value: 1. Maximum value: 100.
dependsOnScheduleId	body	No	string	Optional replacement dependency schedule ID or null.	Minimum length: 1.
isActive	body	No	boolean	Optional active-state toggle; when reactivated, consecutive failure count may be reset by the implementation.	OpenAPI does not declare additional validation metadata.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

{
  "name": "Example agent_builder_schedule",
  "triggerType": "CRON",
  "cronExpression": "example-cronexpression",
  "intervalMinutes": 1,
  "timezone": "example-timezone",
  "blackoutWindows": [
    {}
  ],
  "eventTrigger": "example-eventtrigger",
  "webhookSecret": "example-webhooksecret"
}

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Agent schedule updated for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SAFE_WRITE_DB_ONLY",
    "schedule": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "agentDefinitionId": "00000000-0000-4000-8000-000000000001",
      "name": "Example agent_builder_schedule",
      "triggerType": "CRON",
      "cronExpression": "example-cronexpression",
      "intervalMinutes": 1,
      "timezone": "example-timezone",
      "isActive": true,
      "nextRunAt": "2026-06-08T10:15:30Z",
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "2026-06-08T10:15:30Z"
    }
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request.