# Broadlume Lead API

**Canonical:** https://apis.io/apis/broadlume/broadlume-lead-api/  
**Provider:** Broadlume — https://apis.io/providers/broadlume/  
**Base URL:** https://api.rmaster.com/api  
**Documentation:** https://developer.broadlume.com/bms

Broadlume Lead API is one of 28 APIs that [Broadlume](https://apis.io/providers/broadlume/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Lead. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The Lead API from Broadlume — 22 operation(s) for lead.

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| GET | `/{alias}/leadtimeslots` | Lead Time Slots |
| GET | `/{alias}/leadsbydate` | Leads list |
| POST | `/{alias}/lead` | Creates Lead |
| PATCH | `/{alias}/lead` | Update lead |
| GET | `/{alias}/lead` | Lead detail |
| POST | `/{alias}/leadnotes` | Updates Lead Notes |
| POST | `/{alias}/leadquicknote` | Updates Lead Quick Note |
| POST | `/{alias}/leaddispoqty` | Updates Lead Disp Style/Quantity Notes |
| POST | `/{alias}/leaddispo` | Updates Lead Dispo Notes |
| GET | `/{alias}/leadnonq` | Lead Nonqualified Categories |
| PATCH | `/{alias}/leadnonq` | Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead. |
| GET | `/{alias}/leadzone` | Lead Zone Categories |
| GET | `/{alias}/terrsub` | Subterritory Categories |
| GET | `/{alias}/leadexceptions` | Lead Exception Categories |
| GET | `/{alias}/leadofficenotes` | Lead Office Notes Categories |
| POST | `/{alias}/leadofficenotes` | Create Lead Office Notes |
| PATCH | `/{alias}/leadofficenotes` | Update Lead Office Notes |
| GET | `/{alias}/leadsched` | Lead Scheduling Categories |
| GET | `/{alias}/nonqualified` | Nonqualified Categories |
| GET | `/{alias}/leadmattype` | Lead Mat Type Categories |
| GET | `/{alias}/leadappt` | Lead Appointments |
| POST | `/{alias}/leadproductnotes` | Create Lead Product Notes |
| PATCH | `/{alias}/leadproductnotes` | Updates Lead Product Notes |
| GET | `/{alias}/leadproductnotes` | Gets Lead Product Notes |
| DELETE | `/{alias}/leadproductnotes` | Deletes Lead Product Notes |
| GET | `/{alias}/leadroom` | Get Lead Room |
| POST | `/{alias}/leadroom` | Create Lead Room |
| PATCH | `/{alias}/leadroom` | Update Lead Room |
| DELETE | `/{alias}/leadroom` | Remove Lead Room |
| GET | `/{alias}/roomfile` | Room File |
| GET | `/{alias}/allavailability` | Get All Availability |
| GET | `/{alias}/leadspecials` | Get Lead Specials |
| POST | `/{alias}/convertleadtoquote` | Converts an existing lead into a quote |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/openapi/broadlume-lead-api-openapi.yml
- **Documentation** — https://developer.broadlume.com/bms
- **APIReference** — https://developer.broadlume.com/bms
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/authentication/broadlume-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/conventions/broadlume-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/errors/broadlume-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/data-model/broadlume-data-model.yml
- **Console** — https://developer.broadlume.com/api-runner/broadlume/bms

## Other Broadlume APIs (12)

- [Broadlume Accounts Receivable API](https://apis.io/apis/broadlume/broadlume-accounts-receivable-api/)
- [Broadlume Audit API](https://apis.io/apis/broadlume/broadlume-audit-api/)
- [Broadlume Authentication API](https://apis.io/apis/broadlume/broadlume-authentication-api/)
- [Broadlume Build Order API](https://apis.io/apis/broadlume/broadlume-build-order-api/)
- [Broadlume Bundle API](https://apis.io/apis/broadlume/broadlume-bundle-api/)
- [Broadlume Charge It Pro API](https://apis.io/apis/broadlume/broadlume-chargeitpro-api/)
- [Broadlume Committed API](https://apis.io/apis/broadlume/broadlume-committed-api/)
- [Broadlume Company API](https://apis.io/apis/broadlume/broadlume-company-api/)
- [Broadlume Customer API](https://apis.io/apis/broadlume/broadlume-customer-api/)
- [Broadlume Dashboard API](https://apis.io/apis/broadlume/broadlume-dashboard-api/)
- [Broadlume Edocs API](https://apis.io/apis/broadlume/broadlume-edocs-api/)
- [Broadlume General API](https://apis.io/apis/broadlume/broadlume-general-api/)

## Tags

Lead

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/broadlume/broadlume-lead-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/broadlume/.