---
title: "Update Lead"
method: PATCH
path: "/api/v1.0/leads/{id}"
tags: ["Leads"]
---

# Update Lead

`PATCH /api/v1.0/leads/{id}`

## Path parameters

- `id` string, required

## Request body

- Lead
  - `actioned_at` number — The date/time the last time a Lead was updated at represented as an integer
  - `address` string — The address of the Lead (auto-generated if latitude/longitude are specified)
  - `amount` number — Estimated value of the Lead
  - `campaign_id` integer — The ID of the Campaign the Lead was created on
  - `created_at` number — The date/time the Lead was created at represented as an integer
  - `custom_fields` object — A dictionary of Custom Field values with keys matching the Lead's Campaign Custom Field IDs
  - `description` string — A text description for the Lead
  - `disable_webhooks` boolean — Condition for deciding whether to disable webhook for the Lead
  - `geocoded_address` object
    - `street` string — The street address of the Lead
    - `city` string — The city of the Lead
    - `province` string — The Province/State of the Lead
    - `country` string — The Country of the Lead
    - `postal_code` string — The Zip/Postal Code of the Lead
  - `id` string — The ID of the Lead
  - `identifier` string — The name of the Lead, never null (if the Leads name is empty, it will provide a default string for the Lead)
  - `latitude` number — The latitude coordinate for the Lead's location
  - `longitude` number — The longitude coordinate for the Lead's location
  - `name` string — The name of the Lead
  - `owner_ids` integer[] — The array of IDs of Users who own the Lead
  - `photo_urls` string — An array of urls set associated with the Lead
  - `recording_url` string — A url to a mp3 file for a recorded description
  - `status` 'fresh' | 'received_by_sales' | 'work_in_progress' | 'pending_decision' | 'contract_signed' | 'completed' | 'failed' | 'hibernated' — The current status of the Lead in the Wingmate CRM Pipeline | OneOf("fresh", "received_by_sales", "work_in_progress", "pending_decision", "contract_signed", "completed", "failed", "hibernated")
  - `status_string` string — The name of the status matching the Campaign's lead_statuses field
  - `worker_id` integer — The ID of the user who generated the Lead

## Response `200`

Success

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.dev/wingmateapp/apis/wingmate-api.md) · [All operations](https://skmtc.dev/wingmateapp/apis/wingmate-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wingmateapp/wingmate-api/revisions/d6fccce94b7c/schema)