> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# EmailBison: Update Lead API Leads Lead ID

> Update some of an EmailBison lead's details. fields you leave out stay unchanged. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Update some of an EmailBison lead's details. fields you leave out stay unchanged.

> [!NOTE]
>
> Tool ID: `emailbison_update_lead_api_leads_lead_id`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'emailbison_update_lead_api_leads_lead_id',
  {
    "lead_id": "lead_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_update_lead_api_leads_lead_id --input '{
  "lead_id": "lead_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": "example"
}
```

Use `deepline describe emailbison_update_lead_api_leads_lead_id --json` for the latest machine-readable contract.

## Input reference

Update the details of a specific lead Fields passed in the request will be updated. Fields and custom variables not passed will remain unchanged.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.lead_id` | `string` | Yes | — | Optional parameter. int\|string The ID or email of the lead |
| `payload.first_name` | `string` | No | — | The first name of the contact. |
| `payload.last_name` | `string` | No | — | The last name of the contact. |
| `payload.email` | `string` | No | — | The email address of the contact. Must be in a valid email format. |
| `payload.title` | `string` | No | — | The title of the contact. |
| `payload.company` | `string` | No | — | The company name of the contact. |
| `payload.notes` | `string` | No | — | Additional notes about the contact. |
| `payload.custom_variables` | `array` | No | — | Array of custom variable objects |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Update the details of a specific lead Fields passed in the request will be updated. Fields and custom variables not passed will remain unchanged.",
    "properties": {
      "lead_id": {
        "type": "string",
        "description": "Optional parameter. int|string The ID or email of the lead"
      },
      "first_name": {
        "type": "string",
        "description": "The first name of the contact."
      },
      "last_name": {
        "type": "string",
        "description": "The last name of the contact."
      },
      "email": {
        "type": "string",
        "description": "The email address of the contact. Must be in a valid email format."
      },
      "title": {
        "type": [
          "string",
          "null"
        ],
        "description": "The title of the contact."
      },
      "company": {
        "type": [
          "string",
          "null"
        ],
        "description": "The company name of the contact."
      },
      "notes": {
        "type": [
          "string",
          "null"
        ],
        "description": "Additional notes about the contact."
      },
      "custom_variables": {
        "type": "array",
        "description": "Array of custom variable objects",
        "items": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "name": {
              "description": "name of the custom variable field"
            },
            "value": {
              "description": "value of the custom variable",
              "anyOf": [
                {
                  "type": "null"
                }
              ]
            }
          },
          "additionalProperties": false
        }
      }
    },
    "required": [
      "lead_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `string` | Yes | — | Provider response payload. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "string",
        "description": "Provider response payload."
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [EmailBison provider guide](https://deepline.com/docs/providers/emailbison/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.