> ## Documentation Index > Fetch the complete documentation index at: https://docs.classquill.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Lead > Capture an inbound lead into your org's CRM (e.g. a website quote funnel). The free-form details (name/phone/subject) are stored in the lead's `payload`; `email`, `source_url`, `notes` and a `source_form_name` snapshot are columns; `status` starts at 'new'. `audience` ('student'/'tutor'/'parent') defaults to 'student' when omitted. Honours `Idempotency-Key`. Requires `leads:write` (the coarse `write` umbrella grants it). ## OpenAPI ````yaml /openapi.json post /v1/leads openapi: 3.1.0 info: title: ClassQuill Public API description: >- REST API for ClassQuill tutoring organisations. Pipe your sessions, invoices, payments, tutor earnings, students, and more into your own tools. Most endpoints are reads; a focused set of writes (each gated by a *:write scope) create or update data, including creating student/tutor/parent accounts. Authenticate every request with an org API key: Authorization: Token token=cq_live_... Mint keys in the ClassQuill app under Settings → Developers. version: 1.0.0 servers: [] security: - ApiKeyAuth: [] tags: - name: General - name: Sessions - name: Tutors - name: Students & Parents - name: Billing - name: Curriculum - name: Coursework - name: Operations - name: Pricing - name: Bookings - name: Blog - name: Reports paths: /v1/leads: post: tags: - Bookings summary: Create Lead description: >- Capture an inbound lead into your org's CRM (e.g. a website quote funnel). The free-form details (name/phone/subject) are stored in the lead's `payload`; `email`, `source_url`, `notes` and a `source_form_name` snapshot are columns; `status` starts at 'new'. `audience` ('student'/'tutor'/'parent') defaults to 'student' when omitted. Honours `Idempotency-Key`. Requires `leads:write` (the coarse `write` umbrella grants it). operationId: create_lead_v1_leads_post parameters: - name: Idempotency-Key in: header required: false schema: anyOf: - type: string - type: 'null' title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LeadCreate' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Lead' '401': description: Missing, malformed, revoked, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: The credential lacks the scope this endpoint requires. content: application/json: schema: $ref: '#/components/schemas/ApiError' '422': description: Validation error — `error.details.errors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: >- Rate limit exceeded — honour Retry-After and the RateLimit-* headers. content: application/json: schema: $ref: '#/components/schemas/ApiError' components: schemas: LeadCreate: properties: name: type: string minLength: 1 title: Name description: Lead's full name. email: type: string title: Email description: Lead's email address (required). phone: anyOf: - type: string - type: 'null' title: Phone subject: anyOf: - type: string - type: 'null' title: Subject description: Subject of interest, e.g. 'Methods'. audience: anyOf: - type: string enum: - student - tutor - parent - type: 'null' title: Audience description: >- Who this lead is: 'student' (enrolment, the default), 'tutor' (recruitment), or 'parent' (enrolment, on behalf of a student). Omit to use the org_leads column default ('student'). source_form_name: anyOf: - type: string - type: 'null' title: Source Form Name description: Where the lead came from, e.g. 'website quote funnel'. source_url: anyOf: - type: string - type: 'null' title: Source Url notes: anyOf: - type: string - type: 'null' title: Notes additionalProperties: false type: object required: - name - email title: LeadCreate description: >- POST /v1/leads — capture an inbound lead into the key's org (e.g. a website quote funnel). name/phone/subject are stored in the lead's free-form `payload`; email, source_url, notes and a source_form_name snapshot are columns. organization_id, form_id, status and timestamps are server-set, never accepted; status starts 'new'. Lead: properties: id: type: string title: Id form_id: anyOf: - type: string - type: 'null' title: Form Id source_form_name: anyOf: - type: string - type: 'null' title: Source Form Name name: anyOf: - type: string - type: 'null' title: Name email: anyOf: - type: string - type: 'null' title: Email phone: anyOf: - type: string - type: 'null' title: Phone subject: anyOf: - type: string - type: 'null' title: Subject audience: anyOf: - type: string enum: - student - tutor - parent - type: 'null' title: Audience status: anyOf: - type: string - type: 'null' title: Status assigned_tutor_id: anyOf: - type: string - type: 'null' title: Assigned Tutor Id source_url: anyOf: - type: string - type: 'null' title: Source Url notes: anyOf: - type: string - type: 'null' title: Notes converted_at: anyOf: - type: string - type: 'null' title: Converted At created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At type: object required: - id title: Lead description: |- An inbound lead captured by an org lead form. The free-form `payload` is NOT exposed; only a safe subset (name/email/phone/subject) is flattened. ApiError: description: Canonical error envelope for every /v1 error response (4xx/5xx). properties: error: $ref: '#/components/schemas/ApiErrorBody' required: - error title: ApiError type: object ApiErrorBody: description: The `error` object every /v1 error response carries. properties: code: description: >- Stable machine-readable error code: bad_request, unauthorized, forbidden, not_found, conflict, validation_error, rate_limited, or internal_error. examples: - not_found title: Code type: string message: description: Human-readable explanation, safe to surface to end users. examples: - Session not found title: Message type: string status: description: The HTTP status code, repeated in the body. examples: - 404 title: Status type: integer details: additionalProperties: true description: >- Error-specific context. 422 carries the field errors under `errors`; 429 carries `retry_after_seconds`. title: Details type: object required: - code - message - status title: ApiErrorBody type: object securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Org API key as `Token token=cq_live_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.