> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coi.co.il/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coi.co.il/_mcp/server.

# Update a lead

PATCH https://www.your-store.co.il/api/v1/leads/{id}
Content-Type: application/json

Mark it handled, add notes. Requires `leads:write`.

Reference: https://docs.coi.co.il/leads/update-lead

## Authentication

- `Authorization` header (bearer token, required) — An API key from the store's admin: חנות > API ומפתחות. Send it as `Authorization: Bearer coi_sk_...` (or `X-Api-Key: coi_sk_...`). Never in the URL - `?apikey=` is refused with 400.

## Request

### Path parameters

- `id` (integer, required)

### Body (application/json)

This endpoint expects an object.

- `status` (integer, optional)
- `adminNotes` (string, optional, nullable)

## Response

### 200

The updated lead.

- `ok` (true, optional)
- `data` (Lead, optional)

## Errors

### 400 Bad Request Error

The request is not valid - a field of the wrong type, a missing field, a bad parameter.

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 401 Unauthorized Error

Missing, invalid, revoked or expired API key. The same answer for all of them.

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 403 Forbidden Error

The key lacks the permission (`insufficient_scope`), or the site's plan does not include the API (`plan_required`).

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 404 Not Found Error

No such row in this store (ids of another store are never found).

- `ok` (false, optional)
- `error` (ErrorError, optional)

### 429 Too Many Requests Error

More than 120 requests a minute with one key. Wait `Retry-After` seconds.

- `ok` (false, optional)
- `error` (ErrorError, optional)

## Types

### Lead

- `id` (integer, optional)
- `createdAt` (string, optional)
- `name` (string, optional, nullable)
- `email` (string, optional, nullable)
- `phone` (string, optional, nullable)
- `status` (LeadStatus, optional) — 1 new, 2 read, 3 open, 4 in progress, 5 waiting, 6 done.
- `newsletterOptIn` (boolean, optional, nullable) — null when the form had no consent box.
- `page` (string, optional, nullable) — The page the form was sent from.
- `fields` (list of LeadFieldsItems, optional) — Every field filled in: its label, its English alias when set in the form editor, and the value (true/false for a checkbox).
- `adminNotes` (string, optional, nullable)

### ErrorError

- `code` (string, optional) — Stable, machine-readable: `unauthorized`, `insufficient_scope`, `plan_required`, `invalid_field`, `invalid_parameter`, `invalid_json`, `json_required`, `not_found`, `method_not_allowed`, `nothing_to_update`, `plan_limit`, `email_taken`, `registration_disabled`, `rate_limited`, `too_many_failures`, `https_required`, `key_in_url`, `server_error`.
- `message` (string, optional) — What went wrong, in English, for a person.

### LeadStatus

1 new, 2 read, 3 open, 4 in progress, 5 waiting, 6 done.

- `id` (integer, optional)
- `name` (string, optional)

### LeadFieldsItems

- `name` (string, optional)
- `key` (string, optional, nullable)
- `value` (any, optional)

## Examples

**Request**

```json
{
  "status": 6,
  "adminNotes": "חזרנו אליו, נשלחה הצעה"
}
```

**Response**

```json
{
  "ok": true,
  "data": {
    "id": 1059,
    "createdAt": "2026-09-05T16:09:00+03:00",
    "name": "ישראל ישראלי",
    "email": "israel@example.com",
    "phone": "0501234567",
    "status": {
      "id": 1,
      "name": "חדש"
    },
    "newsletterOptIn": true,
    "page": "צור קשר",
    "fields": [
      {
        "name": "שם מלא",
        "key": "name",
        "value": "ישראל ישראלי"
      },
      {
        "name": "הודעה",
        "key": "message",
        "value": "אשמח להצעת מחיר"
      },
      {
        "name": "מאשר דיוור",
        "key": null,
        "value": true
      }
    ],
    "adminNotes": null
  }
}
```

**SDK Code**

```python Leads_updateLead_example
import requests

url = "https://www.your-store.co.il/api/v1/leads/1"

payload = {
    "status": 6,
    "adminNotes": "חזרנו אליו, נשלחה הצעה"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Leads_updateLead_example
const url = 'https://www.your-store.co.il/api/v1/leads/1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"status":6,"adminNotes":"חזרנו אליו, נשלחה הצעה"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Leads_updateLead_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.your-store.co.il/api/v1/leads/1"

	payload := strings.NewReader("{\n  \"status\": 6,\n  \"adminNotes\": \"חזרנו אליו, נשלחה הצעה\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Leads_updateLead_example
require 'uri'
require 'net/http'

url = URI("https://www.your-store.co.il/api/v1/leads/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": 6,\n  \"adminNotes\": \"חזרנו אליו, נשלחה הצעה\"\n}"

response = http.request(request)
puts response.read_body
```

```java Leads_updateLead_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://www.your-store.co.il/api/v1/leads/1")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": 6,\n  \"adminNotes\": \"חזרנו אליו, נשלחה הצעה\"\n}")
  .asString();
```

```php Leads_updateLead_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://www.your-store.co.il/api/v1/leads/1', [
  'body' => '{
  "status": 6,
  "adminNotes": "חזרנו אליו, נשלחה הצעה"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Leads_updateLead_example
using RestSharp;

var client = new RestClient("https://www.your-store.co.il/api/v1/leads/1");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"status\": 6,\n  \"adminNotes\": \"חזרנו אליו, נשלחה הצעה\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Leads_updateLead_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "status": 6,
  "adminNotes": "חזרנו אליו, נשלחה הצעה"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://www.your-store.co.il/api/v1/leads/1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```