Uproc CLI Reference

Overview

The uproc CLI is the official client for /api/v1/external/* endpoints.

Installation

macOS/Linux (Homebrew)

Install:

brew tap uproc-io/uproc
brew trust uproc-io/uproc   # required on Homebrew 5.5+
brew install uproc

Update:

brew update
brew upgrade uproc

Windows (Scoop)

Install:

scoop bucket add uproc https://github.com/uproc-io/scoop-bucket.git
scoop install uproc

Update:

scoop update
scoop update uproc

Linux/macOS (install script)

curl -fsSL "$UPROC_PROCESSES_API_URL/api/v1/install/cli.sh" | bash
uproc --help

Install a fixed version:

curl -fsSL "$UPROC_PROCESSES_API_URL/api/v1/install/cli.sh?version=v0.1.0" | bash

Credentials

Required values:

UPROC_PROCESSES_API_URL: VALUE
USER_API_KEY: VALUE

Save credentials interactively:

uproc applications login

Output format

CLI output is rendered as human-readable tables/lists (never raw JSON output).

Usage

uproc <command> [subcommand] [args...]

1. Applications commands

install

Get installation plan with a user API key.

uproc applications install <USER_API_KEY> --dry-run

The command calls /api/v1/external/install and prints release versions, required services, and ordered installation steps. In --dry-run mode no server changes are applied.

Default minimum requirements displayed in plan output:

4 vCPU
16 GB RAM
200 GB NVMe disk

Monitoring recommendation included in plan steps:

Install Beszel agent (recommended)

Store credentials for subsequent commands.

uproc applications login

processes request

Run a raw request against /api/v1/external/*.

uproc applications request <METHOD> <PATH> [JSON_BODY]

Example:

uproc applications request GET /api/v1/external/modules

processes interactive

Open interactive CLI mode.

uproc applications interactive

Example session:

uproc> module list
uproc> module get order-track
uproc> request GET /api/v1/external/modules
uproc> help
uproc> exit

processes update check

Validate update readiness with dry-run checks only.

uproc applications update check <USER_API_KEY>

The command calls /api/v1/external/install?dry_run=true and also runs local read-only checks (docker, dokploy, required services, required env vars, and health endpoints).

2. Applications module commands

module list

List available modules.

uproc applications module list

module get

Get module details by slug.

uproc applications module get <module_slug>

Example:

uproc applications module get order-track

module overview

Get module overview and optionally filter sections (kpis, charts, tables).

uproc applications module overview <module_slug> [kpis|charts|tables]

Example:

uproc applications module overview purchase-invoices kpis

module collections

Get collections available for a module.

uproc applications module collections <module_slug>

Example:

uproc applications module collections purchase-invoices

module collection

Get paginated collection rows.

uproc applications module collection <module_slug> <collection_name> [--page 1 --sort-field key --sort-order asc --filter-field key --filter-value val]

Example:

uproc applications module collection purchase-invoices invoices --page 1 --sort-field created_at --sort-order desc

module data

Get module data using /data endpoint.

uproc applications module data <module_slug> <collection_name> [--page 1 --sort-field key --sort-order asc --filter-field key --filter-value val]

module settings-tabs

List available settings tabs for a module (read-only).

uproc applications module settings-tabs <module_slug>

Example:

uproc applications module settings-tabs data-management

module settings-tab

Get values for one settings tab (read-only).

uproc applications module settings-tab <module_slug> <tab_key>

Example:

uproc applications module settings-tab data-management mailboxes

Example:

uproc applications module data order-track orders --page 1

module upload

Upload a file to a module collection.

uproc applications module upload <module_slug> <collection_name> <file_path>

Example:

uproc applications module upload document-ingest folders ./document.pdf

module webhook

Send a webhook payload to a module collection.

uproc applications module webhook <module_slug> <collection_name> <payload_json>

Example:

uproc applications module webhook order-track orders '{"name":"Sync order","message":"Order #12345"}'

forms submit-public

Submit a public Form Generator payload (form-generator).

uproc applications forms submit-public <customer_domain> <form_slug> <payload_json>

Example:

uproc applications forms submit-public demo contact-form '{"email":"[email protected]","country":"ES"}'

This command calls:

POST /api/v1/external/public/modules/form-generator/forms/{customer_domain}/{form_slug}/submit

Request body sent by CLI:

{
  "payload": {
    "email": "[email protected]",
    "country": "ES"
  }
}

Deprecated compatibility alias:

uproc applications module submit-public-form <customer_domain> <form_slug> <payload_json>

forms publish

Publish a form-generator form.

uproc applications forms publish <form_id>

This command calls:

POST /api/v1/external/modules/form-generator/actions/publish

Request body sent by CLI:

{
  "form_id": 12
}

forms archive

Archive a form-generator form.

uproc applications forms archive <form_id>

This command calls:

POST /api/v1/external/modules/form-generator/actions/archive

Request body sent by CLI:

{
  "form_id": 12
}

forms restore

Restore an archived form-generator form.

uproc applications forms restore <form_id>

This command calls:

POST /api/v1/external/modules/form-generator/actions/restore

Request body sent by CLI:

{
  "form_id": 12
}

forms mark-submission-processed

Mark a form-generator submission as processed.

uproc applications forms mark-submission-processed <submission_id>

This command calls:

POST /api/v1/external/modules/form-generator/actions/mark_submission_processed

Request body sent by CLI:

{
  "submission_id": 44
}

forms archive-submission

Archive a form-generator submission.

uproc applications forms archive-submission <submission_id>

This command calls:

POST /api/v1/external/modules/form-generator/actions/archive_submission

Request body sent by CLI:

{
  "submission_id": 44
}

candidate create-profile

Create a candidate-evaluation profile.

uproc applications candidate create-profile <item_json>

This command calls:

POST /api/v1/external/modules/candidate-evaluation/actions/create_profile

Request body sent by CLI:

{
  "item": {
    "full_name": "Eva Ruiz",
    "email": "[email protected]"
  }
}

candidate create-job-opening

Create a candidate-evaluation job opening.

uproc applications candidate create-job-opening <item_json>

This command calls:

POST /api/v1/external/modules/candidate-evaluation/actions/create_job_opening

candidate create-application

Create a candidate-evaluation application.

uproc applications candidate create-application <item_json>

This command calls:

POST /api/v1/external/modules/candidate-evaluation/actions/create_application

candidate move-stage

Move a candidate application to a new stage.

uproc applications candidate move-stage <application_id> <stage>

This command calls:

POST /api/v1/external/modules/candidate-evaluation/actions/move_application_stage

candidate update-status

Update a candidate application status.

uproc applications candidate update-status <application_id> <status>

This command calls:

POST /api/v1/external/modules/candidate-evaluation/actions/update_application_status

candidate create-evaluation

Create a candidate-evaluation evaluation.

uproc applications candidate create-evaluation <item_json>

This command calls:

POST /api/v1/external/modules/candidate-evaluation/actions/create_evaluation

support create-ticket

Create a customer-care ticket.

uproc applications support create-ticket <item_json>

This command calls:

POST /api/v1/external/modules/customer-care/actions/create_ticket

support assign-ticket

Assign a customer-care ticket.

uproc applications support assign-ticket <ticket_id> <assignee>

This command calls:

POST /api/v1/external/modules/customer-care/actions/assign_ticket

support reply-ticket

Reply to a customer-care ticket.

uproc applications support reply-ticket <ticket_id> <message>

This command calls:

POST /api/v1/external/modules/customer-care/actions/reply_to_ticket

support mark-resolved

Mark a customer-care ticket as resolved.

uproc applications support mark-resolved <ticket_id>

This command calls:

POST /api/v1/external/modules/customer-care/actions/mark_resolved

support close-ticket

Close a customer-care ticket.

uproc applications support close-ticket <ticket_id>

This command calls:

POST /api/v1/external/modules/customer-care/actions/close_ticket

support reopen-ticket

Reopen a customer-care ticket.

uproc applications support reopen-ticket <ticket_id>

This command calls:

POST /api/v1/external/modules/customer-care/actions/reopen_ticket

approval approve

Approve an approval-management request.

uproc applications approval approve <request_id>

This command calls:

POST /api/v1/external/modules/approval-management/actions/approve_request

approval reject

Reject an approval-management request.

uproc applications approval reject <request_id>

This command calls:

POST /api/v1/external/modules/approval-management/actions/reject_request

approval reassign

Reassign an approval-management request.

uproc applications approval reassign <request_id> <approver> [note]

This command calls:

POST /api/v1/external/modules/approval-management/actions/reassign_request

approval cancel

Cancel an approval-management request.

uproc applications approval cancel <request_id>

This command calls:

POST /api/v1/external/modules/approval-management/actions/cancel_request

campaign preview-audience

Preview a campaign-automation audience.

uproc applications campaign preview-audience <campaign_id> [limit]

This command calls:

POST /api/v1/external/modules/campaign-automation/actions/preview_audience

campaign add-audience

Add an audience definition to a campaign-automation flow.

uproc applications campaign add-audience <campaign_id> [mode]

This command calls:

POST /api/v1/external/modules/campaign-automation/actions/add_audience

campaign pause

Pause a campaign-automation flow.

uproc applications campaign pause <campaign_id>

This command calls:

POST /api/v1/external/modules/campaign-automation/actions/pause

campaign activate

Activate a campaign-automation flow.

uproc applications campaign activate <campaign_id>

This command calls:

POST /api/v1/external/modules/campaign-automation/actions/activate

campaign sync-audience

Sync a campaign-automation audience to its configured external platforms (e.g. Sendy) as subscribers.

uproc applications campaign sync-audience <campaign_id> <audience_id>

This command calls:

POST /api/v1/external/modules/campaign-automation/actions/sync_audience

campaign launch-platforms

Create and launch a campaign-automation campaign on its configured external platforms (e.g. Sendy).

uproc applications campaign launch-platforms <campaign_id>

This command calls:

POST /api/v1/external/modules/campaign-automation/actions/launch_platforms

contract renew

Renew a contract-lifecycle contract.

uproc applications contract renew <contract_id>

This command calls:

POST /api/v1/external/modules/contract-lifecycle/actions/renew

contract terminate

Terminate a contract-lifecycle contract.

uproc applications contract terminate <contract_id>

This command calls:

POST /api/v1/external/modules/contract-lifecycle/actions/terminate

contract update

Update an existing contract-lifecycle contract.

uproc applications contract update <contract_id> <data_json>

This command calls:

POST /api/v1/external/modules/contract-lifecycle/actions/update_contract

order mark-received

Mark a tracked order as received.

uproc applications order mark-received <order_id>

This command calls:

POST /api/v1/external/modules/order-track/actions/mark_received

order cancel

Cancel a tracked order.

uproc applications order cancel <order_id>

This command calls:

POST /api/v1/external/modules/order-track/actions/cancel_order

order send-reminder

Flag a tracked order for reminder follow-up.

uproc applications order send-reminder <order_id>

This command calls:

POST /api/v1/external/modules/order-track/actions/send_reminder

email mark-processed

Mark an email-assistant email as processed.

uproc applications email mark-processed <email_id>

This command calls:

POST /api/v1/external/modules/email-assistant/actions/mark_processed

Request body sent by CLI:

{
  "email_id": 5
}

email archive

Archive an email-assistant email.

uproc applications email archive <email_id>

This command calls:

POST /api/v1/external/modules/email-assistant/actions/archive_email

Request body sent by CLI:

{
  "email_id": 5
}

process retry-step

Retry the current step of a process-visibility process.

uproc applications process retry-step <process_id>

This command calls:

POST /api/v1/external/modules/process-visibility/actions/retry_step

Request body sent by CLI:

{
  "process_id": 77
}

process reassign-owner

Reassign a process-visibility process to the fallback owner flow.

uproc applications process reassign-owner <process_id>

This command calls:

POST /api/v1/external/modules/process-visibility/actions/reassign_owner

Request body sent by CLI:

{
  "process_id": 77
}

process cancel

Cancel a process-visibility process.

uproc applications process cancel <process_id>

This command calls:

POST /api/v1/external/modules/process-visibility/actions/cancel_process

Request body sent by CLI:

{
  "process_id": 77
}

signals approve

Approve a market-signals signal.

uproc applications signals approve <signal_id>

This command calls:

POST /api/v1/external/modules/market-signals/actions/approve_signal

Request body sent by CLI:

{
  "signal_id": 19
}

signals discard

Discard a market-signals signal.

uproc applications signals discard <signal_id>

This command calls:

POST /api/v1/external/modules/market-signals/actions/discard_signal

Request body sent by CLI:

{
  "signal_id": 19
}

signals mark-pending-review

Move a market-signals signal back to pending review.

uproc applications signals mark-pending-review <signal_id>

This command calls:

POST /api/v1/external/modules/market-signals/actions/mark_pending_review

Request body sent by CLI:

{
  "signal_id": 19
}

signals activate

Activate a reviewed market-signals signal.

uproc applications signals activate <signal_id>

This command calls:

POST /api/v1/external/modules/market-signals/actions/activate_signal

Request body sent by CLI:

{
  "signal_id": 19
}

signals close

Close a market-signals signal.

uproc applications signals close <signal_id>

This command calls:

POST /api/v1/external/modules/market-signals/actions/close_signal

Request body sent by CLI:

{
  "signal_id": 19
}

editorial generate-proposal

Generate an editorial-engine proposal.

uproc applications editorial generate-proposal <opportunity_id>

This command calls:

POST /api/v1/external/modules/editorial-engine/actions/generate_proposal

Request body sent by CLI:

{
  "opportunity_id": 31
}

editorial generate-article

Generate an editorial-engine article draft.

uproc applications editorial generate-article <opportunity_id>

This command calls:

POST /api/v1/external/modules/editorial-engine/actions/generate_article

Request body sent by CLI:

{
  "opportunity_id": 31
}

editorial publish

Publish an editorial-engine opportunity.

uproc applications editorial publish <opportunity_id>

This command calls:

POST /api/v1/external/modules/editorial-engine/actions/publish

Request body sent by CLI:

{
  "opportunity_id": 31
}

editorial schedule

Schedule an editorial-engine opportunity.

uproc applications editorial schedule <opportunity_id>

This command calls:

POST /api/v1/external/modules/editorial-engine/actions/schedule

Request body sent by CLI:

{
  "opportunity_id": 31
}

editorial discard

Discard an editorial-engine opportunity.

uproc applications editorial discard <opportunity_id>

This command calls:

POST /api/v1/external/modules/editorial-engine/actions/discard

Request body sent by CLI:

{
  "opportunity_id": 31
}

signing cancel

Cancel a document-signing request.

uproc applications signing cancel <request_id>

This command calls:

POST /api/v1/external/modules/document-signing/actions/cancel_request

Request body sent by CLI:

{
  "request_id": 52
}

signing reopen

Reopen a document-signing request.

uproc applications signing reopen <request_id>

This command calls:

POST /api/v1/external/modules/document-signing/actions/reopen_request

Request body sent by CLI:

{
  "request_id": 52
}

signing send-reminder

Send a reminder for a document-signing request.

uproc applications signing send-reminder <request_id>

This command calls:

POST /api/v1/external/modules/document-signing/actions/send_reminder

Request body sent by CLI:

{
  "request_id": 52
}

signing sync-status

Sync the status of a document-signing request.

uproc applications signing sync-status <request_id>

This command calls:

POST /api/v1/external/modules/document-signing/actions/sync_status

Request body sent by CLI:

{
  "request_id": 52
}

tax generate

Generate a draft tax-compliance report.

uproc applications tax generate <report_id>

This command calls:

POST /api/v1/external/modules/tax-compliance/actions/generate_report

Request body sent by CLI:

{
  "report_id": 18
}

tax recalculate

Recalculate a tax-compliance report.

uproc applications tax recalculate <report_id>

This command calls:

POST /api/v1/external/modules/tax-compliance/actions/recalculate_report

Request body sent by CLI:

{
  "report_id": 18
}

tax validate

Validate a tax-compliance report.

uproc applications tax validate <report_id>

This command calls:

POST /api/v1/external/modules/tax-compliance/actions/validate_report

Request body sent by CLI:

{
  "report_id": 18
}

tax export

Mark a tax-compliance report as exported.

uproc applications tax export <report_id>

This command calls:

POST /api/v1/external/modules/tax-compliance/actions/export_report

Request body sent by CLI:

{
  "report_id": 18
}

documents mark-ready

Mark a document-generator document as ready.

uproc applications documents mark-ready <document_id>

This command calls:

POST /api/v1/external/modules/document-generator/actions/mark_ready

Request body sent by CLI:

{
  "document_id": 61
}

documents mark-review

Send a document-generator document back to review.

uproc applications documents mark-review <document_id>

This command calls:

POST /api/v1/external/modules/document-generator/actions/mark_review

Request body sent by CLI:

{
  "document_id": 61
}

documents archive

Archive a document-generator document.

uproc applications documents archive <document_id>

This command calls:

POST /api/v1/external/modules/document-generator/actions/archive_document

Request body sent by CLI:

{
  "document_id": 61
}

documents restore

Restore an archived document-generator document.

uproc applications documents restore <document_id>

This command calls:

POST /api/v1/external/modules/document-generator/actions/restore_document

Request body sent by CLI:

{
  "document_id": 61
}

documents regenerate

Regenerate a document-generator document.

uproc applications documents regenerate <document_id>

This command calls:

POST /api/v1/external/modules/document-generator/actions/regenerate_document

Request body sent by CLI:

{
  "document_id": 61
}

inventory mark-received

Mark an inventory-planning order as received.

uproc applications inventory mark-received <order_id>

This command calls:

POST /api/v1/external/modules/inventory-planning/actions/mark_received

Request body sent by CLI:

{
  "order_id": 12
}

inventory cancel

Cancel an inventory-planning order.

uproc applications inventory cancel <order_id>

This command calls:

POST /api/v1/external/modules/inventory-planning/actions/cancel_order

Request body sent by CLI:

{
  "order_id": 12
}

inventory send-reminder

Flag an inventory-planning order for reminder follow-up.

uproc applications inventory send-reminder <order_id>

This command calls:

POST /api/v1/external/modules/inventory-planning/actions/send_reminder

Request body sent by CLI:

{
  "order_id": 12
}

orders-ingest reprocess

Reprocess an order-ingest order.

uproc applications orders-ingest reprocess <order_id>

This command calls:

POST /api/v1/external/modules/order-ingest/actions/reprocess_order

Request body sent by CLI:

{
  "order_id": 12
}

orders-ingest validate

Validate an order-ingest order.

uproc applications orders-ingest validate <order_id>

This command calls:

POST /api/v1/external/modules/order-ingest/actions/validate_order

Request body sent by CLI:

{
  "order_id": 12
}

orders-ingest send-to-erp

Send an order-ingest order to ERP.

uproc applications orders-ingest send-to-erp <order_id>

This command calls:

POST /api/v1/external/modules/order-ingest/actions/send_order_to_erp

Request body sent by CLI:

{
  "order_id": 12
}

cases add-note

Add an internal note to a case-lifecycle case.

uproc applications cases add-note <case_id> <content> [created_by]

This command calls:

POST /api/v1/external/modules/case-lifecycle/actions/create_case_note

Request body sent by CLI:

{
  "case_id": 9,
  "content": "Customer called back"
}

cases close

Close a case-lifecycle case.

uproc applications cases close <case_id>

This command calls:

POST /api/v1/external/modules/case-lifecycle/actions/close_case

Request body sent by CLI:

{
  "case_id": 9
}

cases reopen

Reopen a case-lifecycle case.

uproc applications cases reopen <case_id>

This command calls:

POST /api/v1/external/modules/case-lifecycle/actions/reopen_case

Request body sent by CLI:

{
  "case_id": 9
}

invoice issue

Issue an existing sales-invoices invoice.

uproc applications invoice issue <invoice_id>

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/issue_invoice

Request body sent by CLI:

{
  "invoice_id": 27
}

invoice rectify

Create a rectificative sales-invoices invoice.

uproc applications invoice rectify <invoice_id> [reason]

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/rectify_invoice

Request body sent by CLI:

{
  "invoice_id": 27,
  "reason": "Customer requested correction"
}

invoice send

Send an existing sales-invoices invoice.

uproc applications invoice send <invoice_id> [email] [subject] [message]

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/send_invoice

Request body sent by CLI:

{
  "invoice_id": 27,
  "email": "[email protected]"
}

invoice get-pdf

Get the preview URL for an existing sales-invoices invoice PDF.

uproc applications invoice get-pdf <invoice_id>

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/get_invoice_pdf

Request body sent by CLI:

{
  "invoice_id": 27
}

invoice-lines add

Add a line to an existing sales-invoices invoice.

uproc applications invoice-lines add <invoice_id> <concept> [quantity] [unit_price] [tax_rate] [sort_order]

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/add_invoice_line

Request body sent by CLI:

{
  "invoice_id": 27,
  "concept": "Consulting hours",
  "quantity": 2,
  "unit_price": 120
}

invoice-lines update

Update a line in an existing sales-invoices invoice.

uproc applications invoice-lines update <invoice_id> <line_id> [concept] [quantity] [unit_price] [tax_rate] [sort_order]

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/update_invoice_line

Request body sent by CLI:

{
  "invoice_id": 27,
  "line_id": 3,
  "unit_price": 150
}

invoice-lines delete

Delete a line from an existing sales-invoices invoice.

uproc applications invoice-lines delete <invoice_id> <line_id>

This command calls:

POST /api/v1/external/modules/sales-invoices/actions/delete_invoice_line

Request body sent by CLI:

{
  "invoice_id": 27,
  "line_id": 3
}

sync run

Run a data-sync workflow.

uproc applications sync run <workflow_id>

This command calls:

POST /api/v1/external/modules/data-sync/actions/run_workflow

Request body sent by CLI:

{
  "workflow_id": 14
}

sync preview

Preview a data-sync workflow.

uproc applications sync preview <workflow_id> [limit]

This command calls:

POST /api/v1/external/modules/data-sync/actions/preview_workflow

Request body sent by CLI:

{
  "workflow_id": 14,
  "limit": 10
}

sync dry-run

Dry-run a data-sync workflow.

uproc applications sync dry-run <workflow_id> [limit]

This command calls:

POST /api/v1/external/modules/data-sync/actions/dry_run_workflow

Request body sent by CLI:

{
  "workflow_id": 14,
  "limit": 100
}

sync push-to-erp

Write a record to an ERP provider (Holded / Factura Directa / Invoice Ninja) using a stored ERP credential.

uproc applications sync push-to-erp --credential <id> --resource invoices --operation create --json '{"number":"H-1","total":121}'

This command calls POST /api/v1/external/modules/data-sync/actions/push_to_erp.

sales-invoices verifactu

VeriFactu (Spain) registration helpers.

uproc applications sales-invoices verifactu resubmit <invoice_id>
uproc applications sales-invoices verifactu run
uproc applications sales-invoices verifactu backfill
uproc applications sales-invoices verifactu xml <invoice_id>

resubmit retries the VeriFactu registration of an invoice (re-sends the stored AEAT SF v1.1 XML). Calls POST /api/v1/external/modules/sales-invoices/actions/resubmit_verifactu.
backfill registers already-issued invoices into the VeriFactu chain (F2 backlog). Calls POST /api/v1/external/modules/sales-invoices/actions/backfill_verifactu.
run runs the VeriFactu AEAT data-sync workflow now (sends pending registrations to AEAT).
xml fetches the generated XML. Calls GET /api/v1/external/modules/sales-invoices/data/invoices/<id>/verifactu_xml.

data-chatbot sessions

List the connected user’s data-chatbot sessions, optionally filtered by origin source and channel.

uproc applications data-chatbot sessions [--source web|cli|mcp] [--channel <channel>]

This command calls GET /api/v1/external/modules/data-chatbot/sessions.

file-sync

Copy files between storage providers (SFTP / S3 / Dropbox / Google Drive).

uproc applications file-sync list-transfers [--page 1]
uproc applications file-sync list-runs [--page 1]
uproc applications file-sync run <transfer_id>

run executes a transfer now (copies files with overwrite). It calls POST /api/v1/external/modules/file-sync/actions/run_transfer.

leads generate-proposal

Generate a proposal for a lead-management lead.

uproc applications leads generate-proposal <lead_id> [template_id] [title] [description] [output_format]

This command calls:

POST /api/v1/external/modules/lead-management/actions/generate_lead_proposal

Request body sent by CLI:

{
  "lead_id": 22,
  "output_format": "pdf"
}

leads list

List lead-management leads.

uproc applications leads list [--page 1 --sort-field created_at --sort-order desc --filter-field status --filter-value qualified]

This command calls:

GET /api/v1/external/modules/lead-management/collections/leads?page=1&sort_field=created_at&sort_order=desc&filter_field=status&filter_value=qualified

leads send-proposal

Send a generated proposal to a lead-management lead by email.

uproc applications leads send-proposal <lead_id> <mailbox_id> <to_email> <subject> <body> [proposal_url]

This command calls:

POST /api/v1/external/modules/lead-management/actions/send_lead_proposal

Request body sent by CLI:

{
  "lead_id": 22,
  "mailbox_id": 4,
  "to_email": "[email protected]",
  "subject": "Proposal",
  "body": "Please review the attached proposal"
}

leads rerun-intelligence

Rerun intelligence for a lead-management lead.

uproc applications leads rerun-intelligence <lead_id>

This command calls:

POST /api/v1/external/modules/lead-management/actions/rerun_lead_intelligence

Request body sent by CLI:

{
  "lead_id": 22
}

leads upload-proposal

Upload a proposal PDF to a lead and create a proposal version. Does NOT send email.

uproc applications leads upload-proposal 66 ./proposal.pdf

This command calls:

POST /api/v1/external/modules/lead-management/actions/upload_proposal

Request body sent by CLI:

{
  "lead_id": 66,
  "pdf_content": "<base64 PDF content>",
  "file_name": "./proposal.pdf",
  "proposal_key": "F0"
}

Optional flags:

--proposal-key (string): Key to group versions of the same proposal (default: file name)

leads send-proposal-version

Send an existing proposal version to the client by email with tracking link.

uproc applications leads send-proposal-version 42 --subject "Proposal" --body "Please review"

This command calls:

POST /api/v1/external/modules/lead-management/actions/send_proposal_version

Request body sent by CLI:

{
  "version_id": 42,
  "to_email": "",
  "subject": "Proposal",
  "body": "Please review"
}

Optional flags:

--to-email (string): Recipient email (default: lead’s email field)
--subject (string): Email subject
--body (string): Email body

prospecting run-discovery

Run discovery for a lead-prospecting strategy.

uproc applications prospecting run-discovery <strategy_id> [company] [domain]

This command calls:

POST /api/v1/external/modules/lead-prospecting/actions/run_discovery

Request body sent by CLI:

{
  "strategy_id": 7,
  "company": "ACME"
}

prospecting send-to-leads

Send a lead-prospecting opportunity into lead management.

uproc applications prospecting send-to-leads <opportunity_id>

This command calls:

POST /api/v1/external/modules/lead-prospecting/actions/send_opportunity_to_leads

Request body sent by CLI:

{
  "opportunity_id": 33
}

reconciliation reconcile

Run financial-reconciliation.

uproc applications reconciliation reconcile [process_id]

This command calls:

POST /api/v1/external/modules/financial-reconciliation/actions/reconcile

Request body sent by CLI:

{
  "process_id": 41
}

chat ask

Send a natural-language query to data-chatbot.

uproc applications chat ask <domain> <question> [context] [channel] [sender_id] [origin_session_id]

This command calls:

POST /api/v1/external/modules/data-chatbot/actions/send_chat_query

Request body sent by CLI:

{
  "domain": "sales",
  "question": "Which leads are closest to conversion?"
}

data-chatbot domains

List the available data-chatbot domains (channels) and their sample questions.

uproc applications data-chatbot domains

This command calls:

GET /api/v1/external/modules/data-chatbot/data_domains

data-chatbot follow-up

Continue an existing data-chatbot conversation (session) with a new question. The channel, domain and context default to the session’s last request.

uproc applications data-chatbot follow-up <origin_session_id> <question> [channel] [domain] [origin_user_id]

This command calls:

POST /api/v1/external/modules/data-chatbot/actions/follow_up

data-chatbot interactive

Guided flow: pick a data domain, select or edit one of the available questions, send it, and keep following up (or switch channel/domain).

uproc applications data-chatbot interactive

purchase-invoices validate

Mark a purchase-invoices invoice as validated.

uproc applications purchase-invoices validate <id> [reason]

This command calls:

PUT /api/v1/external/modules/purchase-invoices/data/purchase_invoices/{id}/status

Request body sent by CLI:

{
  "status": "validated",
  "reason": ""
}

purchase-invoices pay

Mark a purchase-invoices invoice as paid.

uproc applications purchase-invoices pay <id> [reason]

This command calls:

PUT /api/v1/external/modules/purchase-invoices/data/purchase_invoices/{id}/status

Request body sent by CLI:

{
  "status": "paid",
  "reason": ""
}

purchase-invoices assign-from-ingest

Assign a parsed purchase invoice from purchase-invoices into purchase-invoices.

uproc applications purchase-invoices assign-from-ingest <invoice_id> [payload_json]

This command calls:

POST /api/v1/external/modules/purchase-invoices/actions/assign_from_ingest

Request body sent by CLI:

{
  "invoice_id": 42
}

Business-verb list commands

The curated business-verb groups now expose read/list subcommands that wrap the same collection endpoint family as uproc applications module collection.

Common flags available on every business-verb list command:

--page 1 --sort-field created_at --sort-order desc --filter-field status --filter-value qualified

Examples:

uproc applications forms list [--page 1]
uproc applications forms list-fields [--page 1]
uproc applications forms list-submissions [--page 1]
uproc applications candidate list-profiles [--page 1]
uproc applications candidate list-job-openings [--page 1]
uproc applications candidate list-applications [--page 1]
uproc applications candidate list-evaluations [--page 1]
uproc applications candidate list-stage-events [--page 1]
uproc applications support list [--page 1]
uproc applications approval list [--page 1]
uproc applications campaign list [--page 1]
uproc applications campaign list-audiences [--page 1]
uproc applications contract list [--page 1]
uproc applications contract list-expiring [--page 1]
uproc applications contract list-by-counterparty [--page 1]
uproc applications order list [--page 1]
uproc applications email list [--page 1]
uproc applications process list [--page 1]
uproc applications signals list [--page 1]
uproc applications signals list-executions [--page 1]
uproc applications signals list-activations [--page 1]
uproc applications editorial list-opportunities [--page 1]
uproc applications editorial list-projects [--page 1]
uproc applications editorial list-articles [--page 1]
uproc applications editorial list-combined [--page 1]
uproc applications signing list [--page 1]
uproc applications tax list [--page 1]
uproc applications documents list [--page 1]
uproc applications inventory list [--page 1]
uproc applications orders-ingest list [--page 1]
uproc applications orders-ingest list-emails [--page 1]
uproc applications cases list [--page 1]
uproc applications cases list-by-status [--page 1]
uproc applications cases list-by-type [--page 1]
uproc applications invoice list [--page 1]
uproc applications invoice-lines list [--page 1]
uproc applications sync list-workflows [--page 1]
uproc applications sync list-runs [--page 1]
uproc applications sync list-records [--page 1]
uproc applications leads list [--page 1]
uproc applications prospecting list-strategies [--page 1]
uproc applications prospecting list-opportunities [--page 1]
uproc applications prospecting list-prospects [--page 1]
uproc applications prospecting list-executions [--page 1]
uproc applications reconciliation list-entries [--page 1]
uproc applications reconciliation list-extracts [--page 1]
uproc applications reconciliation list-exports [--page 1]
uproc applications reconciliation list-matches [--page 1]
uproc applications chat list [--page 1]
uproc applications data-chatbot list [--page 1]
uproc applications purchase-invoices list [--page 1]
uproc applications purchase-invoices list-lines [--page 1]
uproc applications purchase-invoices list-payments [--page 1]

All these commands call:

GET /api/v1/external/modules/{module_slug}/collections/{collection_name}

4. Profile commands

profile list

List profiles with their API URL and whether a user API key is configured. Keys are never printed.

uproc profile list

profile add

Interactively prompt for an API URL and user API key, save the named profile, and activate it.

uproc profile add <profile_name>

profile show

Show the active profile API URL and user API key status without printing the key.

uproc profile show

profile use

Set active profile.

uproc profile use <profile_name>

4.5 Data-process and connected-user profile commands

uproc applications data-process search [query]
uproc applications data-process tool <key>
uproc applications data-process execute <tool> [params_json]
uproc applications data-process batch <tool> <source_entity_id> [column_mapping_json] [fixed_values_json] [output_name]
uproc applications data-process runs
uproc me get
uproc me update first_name=Jane language=es default_app=data-process

data-process search finds tools by key/name/description; data-process tool <key> shows the full spec (params, accepted values, format, cost) so you know exactly how to call execute; execute runs a tool inline (no daily inline-call limit; balance and daily budget apply); batch queues a background run over a data-management entity; me reads/updates the bearer-token user’s profile.


`data-process execute` runs a tool inline (no daily inline-call limit; balance and daily budget apply). `data-process batch` queues a background run over a data-management entity. `me` reads/updates the bearer-token user's profile.

Migrated data-process tools are served by the native Python implementation; tools not yet migrated fall back to the legacy platform automatically (`DATA_PROCESS_TOOLS_MODE=auto`). A native tool depending on an external provider is used only when its `TOOL_*` credential env var is configured, otherwise it falls back to legacy. Catalog and execution responses include `execution_mode` (`native` or `legacy_bypass`).

## 5. Authentication headers

- `Authorization: Bearer <USER_API_KEY>`

CLI Reference

Uproc CLI Reference

Overview

Installation

macOS/Linux (Homebrew)

Windows (Scoop)

Linux/macOS (install script)

Credentials

Output format

Usage

Index

1. Applications commands

install

processes login

processes request

processes interactive

processes update check

2. Applications module commands

module list

module get

module overview

module collections

module collection

module data

module settings-tabs

module settings-tab

module upload

module webhook

forms submit-public

forms publish

forms archive

forms restore

forms mark-submission-processed

forms archive-submission

candidate create-profile

candidate create-job-opening

candidate create-application

candidate move-stage

candidate update-status

candidate create-evaluation

support create-ticket

support assign-ticket

support reply-ticket

support mark-resolved

support close-ticket

support reopen-ticket

approval approve

approval reject

approval reassign

approval cancel

campaign preview-audience

campaign add-audience

campaign pause

campaign activate

campaign sync-audience

campaign launch-platforms

contract renew

contract terminate

contract update

order mark-received

order cancel

order send-reminder

email mark-processed

email archive

process retry-step

process reassign-owner

process cancel

signals approve

signals discard

signals mark-pending-review

signals activate

signals close

editorial generate-proposal

editorial generate-article

editorial publish

editorial schedule

editorial discard

signing cancel

signing reopen

signing send-reminder