solarOS Organization API

Organization API

Leads

Create, list, update, delete, and convert Leads with Campaign attribution, Sales Type assignment, schema-aware Field Values, and durable External References.

Lead intake pattern

Fetch schema first, discover valid Lead Sources and Team Members, then create Leads with standard fields, Field Values, and External References in one idempotent request.

For website forms, include the matching Campaign id, Sales Type ids, Lead Source id, and an External Reference for the form submission id so retries and reconciliation stay deterministic.

After create or update, fetch the Lead to confirm normalized status, hydrated Field Values, owner assignment, and request metadata.

Conversion boundary

Lead conversion creates the downstream customer, property link, and opportunity inside the organization boundary. Reuse the same idempotency key only for the same business action.

Operations