> ## Documentation Index > Fetch the complete documentation index at: https://api.leadey.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update lead status > Moves a lead to a different status, records the transition on the lead's timeline, and fires the same **Status changed** trigger the Cockpit does, so any workflow watching for that status runs. The key is validated against your workspace's own status list — get it from `GET /lead-statuses`. An unknown key returns `400` rather than silently storing a status nothing in the product recognises. ## OpenAPI ````yaml /openapi.json patch /leads/{id}/status openapi: 3.1.0 info: title: Leadey API version: 1.4.0 description: >- The Leadey API gives you programmatic access to your workspace: leads, companies, contacts, campaigns, meetings, opportunities and calls, plus the reporting metrics behind the Cockpit. Every request is authenticated with an organization-scoped API key, and every response is JSON. Reads work with any key. Writes — creating leads, adding notes, logging calls, managing tasks — need a key with write access, and are attributed to the workspace member that key belongs to. See [Writing data](/guides/writing-data). servers: - url: https://backend.leadey.ai/v1 description: Production - url: http://localhost:3001/v1 description: Local development security: - bearerAuth: [] tags: - name: Account description: The organization behind the API key. - name: Leads description: People enrolled in your campaigns. - name: Notes description: >- Free-text notes on a lead. Notes appear in the lead's timeline and in the Cockpit. - name: Tasks description: Follow-ups and reminders, each assigned to a workspace member. - name: Campaigns description: Outreach sequences and their performance. - name: Companies description: Companies in your workspace. - name: Contacts description: The canonical person record behind your leads. - name: Meetings description: Bookings merged across Calendly, Leadey and connected calendars. - name: Opportunities description: Deals, their value, and the pipelines they sit in. - name: Pipelines description: Deal pipelines and the stages inside them. - name: Calls description: Dial history, recordings and transcripts. - name: Metrics description: >- Aggregated reporting — meetings booked, sit rate, dial activity and pipeline value. - name: Reference description: The vocabularies other endpoints return values from. paths: /leads/{id}/status: patch: tags: - Leads summary: Update lead status description: >- Moves a lead to a different status, records the transition on the lead's timeline, and fires the same **Status changed** trigger the Cockpit does, so any workflow watching for that status runs. The key is validated against your workspace's own status list — get it from `GET /lead-statuses`. An unknown key returns `400` rather than silently storing a status nothing in the product recognises. operationId: updateLeadStatus parameters: - $ref: '#/components/parameters/LeadId' requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: The new status key, as returned by `GET /lead-statuses`. required: - status example: status: qualified responses: '200': description: The updated lead. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Lead' required: - data example: data: id: lead_8Kq2mXvR name: Priya Raman firstName: Priya lastName: Raman title: Head of Revenue Operations company: Northwind Logistics email: priya.raman@northwind.co.uk phone: '+442071838750' linkedinUrl: https://www.linkedin.com/in/priyaraman status: pending source: linkedin-search score: 78 campaignId: fnl_Q3OutboundUK campaignName: Q3 outbound, UK logistics createdAt: '2026-07-14T09:12:44.000Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: parameters: LeadId: name: id in: path required: true description: The lead id. schema: type: string schemas: Lead: type: object properties: id: type: string name: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' title: type: string company: type: string email: type: - string - 'null' phone: type: - string - 'null' linkedinUrl: type: - string - 'null' status: type: string example: pending source: type: string score: type: integer example: 78 campaignId: type: - string - 'null' description: >- The campaign this lead is enrolled in, or null when it isn't in one. A lead with no campaign isn't enrolled in any automation and receives nothing until it's added to one. campaignName: type: - string - 'null' createdAt: type: string format: date-time customFields: type: object additionalProperties: type: string description: >- Your workspace's custom fields for this lead, keyed by field key. The same shape you send when writing, so a value round-trips unchanged. Present on `GET /leads`, `GET /leads/{id}`, `POST /leads` and `PATCH /leads/{id}`. Endpoints that don't load custom fields omit the key entirely rather than returning an empty object. example: legacy_record_id: REC-90412 legacy_created_at: '2023-04-11' updatedAt: type: string format: date-time description: When this lead was last modified. required: - id - name - status - createdAt Error: type: object properties: error: type: object properties: message: type: string description: Human-readable error message. details: type: - object - array - string - 'null' description: Optional structured detail. required: - message responses: BadRequest: description: The request was malformed, or a required field was missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: message: One of email, phone or linkedinUrl is required details: null Unauthorized: description: The API key is missing, invalid, or revoked. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: message: Invalid or revoked API key. details: null Forbidden: description: >- The key is read-only, or the workspace is not currently allowed to write (payment method missing, trial expired, payment overdue, or subscription cancelled). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: message: >- This API key is read-only. Create a key with write access in Settings → API Keys. details: null NotFound: description: The resource does not exist or is not in your workspace. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: message: Lead not found details: null RateLimited: description: Too many requests. Retry after the period in the `Retry-After` header. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: message: Rate limit exceeded. Retry in 42s. details: null securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your API key, created in the Leadey dashboard under Settings → API Keys. Send it as `Authorization: Bearer leadey_sk_live_…`. ````