---
title: "Update a sales lead"
method: PATCH
path: "/sales_leads/{id}"
tags: ["Sales Leads"]
---

# Update a sales lead

`PATCH /sales_leads/{id}`

**Plan: Paid API.**

## Request body

- SalesLeadWrite — Flat (non-wrapped) `snake_case` payload.
  - `title` string, required
  - `details` string
  - `qualified` boolean
  - `company_id` string, uuid
  - `company_name` string
  - `primary_contact_id` string, uuid
  - `primary_contact_name` string
  - `email` string
  - `phone_number` string
  - `sales_rep_id` string, uuid
  - `sales_rep_name` string
  - `deal_value_in_dollars` number
  - `workflow_state` string
  - `next_contact_date` string, date
  - `expected_close_date` string, date
  - `lead_source_id` string, uuid
  - `lead_source_name` string
  - `pipeline_id` string, uuid
  - `pipeline_name` string
  - `pipeline_stage_id` string, uuid
  - `pipeline_stage_name` string
  - `division_id` string, uuid
  - `lead_source_real_name` string
  - `asset` string[] — Asset references to attach to the lead.

## Response `200`

Updated.

- SalesLead
  - `id` string, uuid
  - `title` string
  - `details` string, nullable
  - `workflowState` string, nullable
  - `nextContactDate` string, date, nullable
  - `expectedCloseDate` string, date, nullable
  - `qualified` boolean, nullable
  - `dealValueInDollars` number, nullable — US dollars.
  - `createdAt` string, date-time
  - `createdById` string, uuid, nullable
  - `updatedById` string, uuid, nullable
  - `companyId` string, uuid, nullable
  - `company` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `leadSourceId` string, uuid, nullable
  - `leadSource` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `salesRepId` string, uuid, nullable
  - `salesRep` Party — A person reference (sales rep, PM, designer) with initials.
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `pipelineStageId` string, uuid, nullable
  - `pipelineStage` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `primaryContactId` string, uuid, nullable
  - `primaryContact` object
    - `id` string, uuid
    - `name` string
    - `email` string, nullable
  - `pipelineId` string, uuid, nullable
  - `pipeline` object
    - `id` string, uuid
    - `name` string
    - `stages` object[]
      - `id` string, uuid
      - `name` string
      - `position` integer
  - `assignedToId` string, uuid, nullable
  - `assignedTo` Party — A person reference (sales rep, PM, designer) with initials.
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `divisionId` string, uuid, nullable
  - `division` object — Full division record (all columns), present only when the lead has a division.

## Other responses

- `422` — Unprocessable entity - field errors keyed by attribute.

---

[API](https://skmtc.net/shopvox/apis/shopvox-public-api.md) · [All operations](https://skmtc.net/shopvox/apis/shopvox-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopvox/shopvox-public-api/versions/7ac1ff5d444a/schema)