> ## 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.

# Smartlead: Manage Client API Keys

> Managing client API keys (generate or revoke). Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Managing client API keys (generate or revoke).

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

## 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(
  'smartlead_manage_client_api_keys',
  {
    "client_id": "client_123",
    "action": "list",
    "api_key_id": "api_key_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute smartlead_manage_client_api_keys --input '{
  "client_id": "client_123",
  "action": "list",
  "api_key_id": "api_key_123"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe smartlead_manage_client_api_keys --json` for the complete live contract.

## Input reference

Smartlead manage client API keys input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.client_id` | `string \| integer` | No | — | Client identifier. Required for generate and optional for list filters. |
| `payload.action` | `"list" \| "generate" \| "reset" \| "revoke"` | No | — | API key action to perform. Allowed: `list`, `generate`, `reset`, `revoke`. |
| `payload.api_key_id` | `string \| integer` | No | — | Client API key identifier for reset/revoke operations. |
| `payload.key_name` | `string` | No | — | API key label. Required for generate and optional as a list filter. Minimum length: 1. |
| `payload.status` | `string` | No | — | Optional API key status filter. Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Smartlead manage client API keys input.",
    "properties": {
      "client_id": {
        "description": "Client identifier. Required for generate and optional for list filters.",
        "anyOf": [
          {
            "type": "string",
            "minLength": 1
          },
          {
            "type": "integer",
            "minimum": 1
          }
        ]
      },
      "action": {
        "type": "string",
        "description": "API key action to perform.",
        "enum": [
          "list",
          "generate",
          "reset",
          "revoke"
        ]
      },
      "api_key_id": {
        "description": "Client API key identifier for reset/revoke operations.",
        "anyOf": [
          {
            "type": "string",
            "minLength": 1
          },
          {
            "type": "integer",
            "minimum": 1
          }
        ]
      },
      "key_name": {
        "type": "string",
        "description": "API key label. Required for generate and optional as a list filter.",
        "minLength": 1
      },
      "status": {
        "type": "string",
        "description": "Optional API key status filter.",
        "minLength": 1
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Raw Smartlead manage client API keys payload.

The static output schema is not available. Run `deepline describe smartlead_manage_client_api_keys --json` for the live contract.

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "description": "Raw Smartlead manage client API keys payload."
  }
  ```
</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

* [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.