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

# UpdateLeadCustomFields

PATCH https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/{campaignId}/leads/custom-fields
Content-Type: application/json

Update (upsert) custom fields on a lead in a campaign. Keys are field names, values are field values.

- If a field exists: its value is updated.
- If a field does not exist: it is created.
- If the value is null or an empty string: the field is deleted.

Up to 100 custom fields per request. Field names max 128 chars, values max 2048 chars. `leadMemberIdOrUrl` accepts a LinkedIn member id or a (URL-encoded) profile URL. Returns the final state of all custom fields on the lead (the `listId` is the campaign's underlying lead list).

Reference: https://docs.heyreach.io/hey-reach-api/campaigns/update-lead-custom-fields

## Request

### Path parameters

- `campaignId` (string, required)

### Headers

- `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}"

### Body (application/json)

This endpoint expects an object.

- `leadMemberIdOrUrl` (string, required)
- `customFields` (object, required)
  - `custom_field_1` (string, required)
  - `custom_field_2` (string, required)
  - `custom_field_3` (string, required)

## Response

### 200

OK

- `leadId` (string, required)
- `listId` (integer, required)
- `customFields` (list of object, required)
  - `name` (string, required)
  - `value` (string, required)

## Examples

**Request**

```json
{
  "leadMemberIdOrUrl": "13123123",
  "customFields": {
    "custom_field_1": "value_1",
    "custom_field_2": "value_2",
    "custom_field_3": "value_3"
  }
}
```

**Response**

```json
{
  "leadId": "13123123",
  "listId": 123456,
  "customFields": [
    {
      "name": "custom_field_1",
      "value": "value_1"
    },
    {
      "name": "custom_field_2",
      "value": "value_2"
    },
    {
      "name": "custom_field_3",
      "value": "value_3"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields"

payload = {
    "leadMemberIdOrUrl": "13123123",
    "customFields": {
        "custom_field_1": "value_1",
        "custom_field_2": "value_2",
        "custom_field_3": "value_3"
    }
}
headers = {
    "X-API-KEY": "<YOUR_API_KEY>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields';
const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<YOUR_API_KEY>', 'Content-Type': 'application/json'},
  body: '{"leadMemberIdOrUrl":"13123123","customFields":{"custom_field_1":"value_1","custom_field_2":"value_2","custom_field_3":"value_3"}}'
};

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

```go
package main

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

func main() {

	url := "https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields"

	payload := strings.NewReader("{\n  \"leadMemberIdOrUrl\": \"13123123\",\n  \"customFields\": {\n    \"custom_field_1\": \"value_1\",\n    \"custom_field_2\": \"value_2\",\n    \"custom_field_3\": \"value_3\"\n  }\n}")

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

	req.Header.Add("X-API-KEY", "<YOUR_API_KEY>")
	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
require 'uri'
require 'net/http'

url = URI("https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<YOUR_API_KEY>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"leadMemberIdOrUrl\": \"13123123\",\n  \"customFields\": {\n    \"custom_field_1\": \"value_1\",\n    \"custom_field_2\": \"value_2\",\n    \"custom_field_3\": \"value_3\"\n  }\n}"

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

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

HttpResponse<String> response = Unirest.patch("https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields")
  .header("X-API-KEY", "<YOUR_API_KEY>")
  .header("Content-Type", "application/json")
  .body("{\n  \"leadMemberIdOrUrl\": \"13123123\",\n  \"customFields\": {\n    \"custom_field_1\": \"value_1\",\n    \"custom_field_2\": \"value_2\",\n    \"custom_field_3\": \"value_3\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields', [
  'body' => '{
  "leadMemberIdOrUrl": "13123123",
  "customFields": {
    "custom_field_1": "value_1",
    "custom_field_2": "value_2",
    "custom_field_3": "value_3"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '<YOUR_API_KEY>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields");
var request = new RestRequest(Method.PATCH);
request.AddHeader("X-API-KEY", "<YOUR_API_KEY>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"leadMemberIdOrUrl\": \"13123123\",\n  \"customFields\": {\n    \"custom_field_1\": \"value_1\",\n    \"custom_field_2\": \"value_2\",\n    \"custom_field_3\": \"value_3\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-KEY": "<YOUR_API_KEY>",
  "Content-Type": "application/json"
]
let parameters = [
  "leadMemberIdOrUrl": "13123123",
  "customFields": [
    "custom_field_1": "value_1",
    "custom_field_2": "value_2",
    "custom_field_3": "value_3"
  ]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/campaign/UpdateLeadCustomFields/campaigns/12345/leads/custom-fields")! 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()
```