> ## 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.
# Clickhouse Organization Update: Inputs, Cost & CLI Example
> Update organization details. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_organization_update:{"organizationId":"{{organizationId}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `payload.organizationId` | `string` | Yes | | ID of the organization to update. |
| `payload.name` | `string` | No | | Name of the organization. |
| `payload.privateEndpoints` | `object` | No | | |
| `payload.enableCoreDumps` | `boolean` | No | | Whether crash reports (core dumps) collection is enabled for services in the organization. When disabled at the organization level, individual services cannot enable crash reports. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Updates organization fields. Requires ADMIN auth key role.",
"properties": {
"organizationId": {
"type": "string",
"description": "ID of the organization to update.",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name of the organization."
},
"privateEndpoints": {
"properties": {
"add": {
"type": "array",
"description": "DEPRECATED. Elements to add. Executed after \"remove\" part is processed. Please use the `Update Service Basic Details` endpoint with the `privateEndpointIds` field instead to modify the private endpoints.",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Private endpoint identifier"
},
"description": {
"type": "string",
"description": "Optional description of private endpoint"
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider in which the private endpoint is lcoated",
"enum": [
"gcp",
"aws",
"azure"
]
},
"region": {
"type": "string",
"description": "Region in which the private endpoint is located",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
}
},
"additionalProperties": false
}
},
"remove": {
"type": "array",
"description": "Elements to remove. Executed before \"add\" part is processed.",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Private endpoint identifier"
},
"description": {
"type": "string",
"description": "Optional description of private endpoint"
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider in which the private endpoint is lcoated",
"enum": [
"gcp",
"aws",
"azure"
]
},
"region": {
"type": "string",
"description": "Region in which the private endpoint is located",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"enableCoreDumps": {
"type": "boolean",
"description": "Whether crash reports (core dumps) collection is enabled for services in the organization. When disabled at the organization level, individual services cannot enable crash reports."
}
},
"required": [
"organizationId"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"status": {
"type": "number",
"description": "HTTP status code."
},
"requestId": {
"type": "string",
"description": "Unique id assigned to every request. UUIDv4",
"format": "uuid"
},
"result": {
"properties": {
"id": {
"type": "string",
"description": "Unique organization ID.",
"format": "uuid"
},
"createdAt": {
"type": "string",
"description": "The timestamp the organization was created. ISO-8601.",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Name of the organization."
},
"privateEndpoints": {
"type": "array",
"description": "List of private endpoints for organization",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Private endpoint identifier"
},
"description": {
"type": "string",
"description": "Description of private endpoint"
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider in which the private endpoint is lcoated",
"enum": [
"gcp",
"aws",
"azure"
]
},
"region": {
"type": "string",
"description": "Region in which the private endpoint is located",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
}
},
"additionalProperties": false
}
},
"byocConfig": {
"type": "array",
"description": "BYOC configuration for the organization",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the BYOC configuration"
},
"state": {
"type": "string",
"description": "State of the infrastructure",
"enum": [
"infra-ready",
"infra-provisioning",
"infra-terminated"
]
},
"accountName": {
"type": "string",
"description": "Name of the account"
},
"regionId": {
"type": "string",
"description": "Region for which the BYOC has been configured and where it is possible to create services",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider of the region",
"enum": [
"gcp",
"aws",
"azure"
]
},
"displayName": {
"type": "string",
"description": "Human readable name for infrastructure"
}
},
"additionalProperties": false
}
},
"enableCoreDumps": {
"type": "boolean",
"description": "Whether crash reports (core dumps) collection is enabled for services in the organization. When disabled at the organization level, individual services cannot enable crash reports."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute clickhouse_organization_update --payload '{
"organizationId": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.