Learn how to interact with this route using the Ouro SDK or REST API.
API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.
Parameters and request body schema for this route.
Recipient email address
Email HTML body
coldfollowupreplynudgeEmail intent for idempotency key and CRM logic
Zero-side-effect preview: performs the read-only CRM lookup, builds the exact send payload and would-be CRM row, but sends no email and writes nothing to the CRM.
Email subject line
Inbound message id being replied to, or 'first' for cold, or 'followup-{email_id}'
CRM row id for this contact
Workspace path to the file
Download name; defaults to the path basename
Optional MIME type
Workspace files to attach. Each item needs path (relative to workspace root or /workspace/...). filename defaults to the basename.
CRM next action after the send
For a new CRM row: name, type, institution, email, focus, batch, and optional next_action
Legacy hint retained for compatibility; first-send status is detected from the CRM row
For live-thread replies: updated CRM reply_received note (e.g. append that the open question was answered). Optional.
Today's total outbound count (from outreach-triage / Resend). At >= 8, cold/followup/nudge sends are refused with daily_cap_exceeded; a live-thread reply is still allowed and still counts.
Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route ID or identifier.
Execute the route endpoint with request body, query parameters, path parameters, or asset IDs.
Get the request and response history for this route. Actions are especially useful for long-running routes where you can poll the status and retrieve the response when ready.
import os
from ouro import Ouro
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
# Option 1: Retrieve by route ID
route_id = "c1782c41-a034-468f-9a03-bb7e946ecd2c"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "hermes/send-outreach-email-and-log-to-crm"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("hermes/send-outreach-email-and-log-to-crm")
# Execute the route
action = route.execute(
body={
'to': 'example_string',
'html': 'example_string',
'intent': 'example_string',
'dry_run': False,
'subject': 'example_string',
'trigger': 'first',
'contact_id': 'example_string',
'attachments': [],
'next_action': 'example_string',
'contact_fields': {},
'crm_dataset_id': '019ee292-8c6c-7038-81c4-46eb601c31b6',
'is_new_contact': False,
'reply_received': 'example_string',
'daily_outbound_count': 0
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("hermes/send-outreach-email-and-log-to-crm")
# Read all actions (request/response history) for this route
actions = route.read_actions()
print(actions)
# Actions are especially useful for long-running routes
# You can poll the status and retrieve the response when ready
for action in actions:
print(f"Action ID: {action['id']}")
print(f"Status: {action['status']}")
print(f"Response: {action.get('response_data')}")Send an outreach email with optional workspace-file attachments, idempotency, and required CCs, then record it in the CRM.
Execution
Usage
1 callView history