---
title: "Update a saved query"
---

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

Path: Channel Automation API › Analytics

`PUT /api/analytics/saved-queries/{id}`

## Authentication

Requires one of the following:

- `bearerAuth`
- `apiKey`

## Path parameters

- `id` (`put/api/analytics/saved-queries/id.path.id`; string, required) — Saved query ID
  - format `uuid`

## Request body

_Required._

- `name` (`put/api/analytics/saved-queries/id.name`; string, optional)
- `description` (`put/api/analytics/saved-queries/id.description`; string, optional)
- `query_config` (`put/api/analytics/saved-queries/id.query_config`; object, optional)
- `sql_query` (`put/api/analytics/saved-queries/id.sql_query`; string, optional)
- `visualization_config` (`put/api/analytics/saved-queries/id.visualization_config`; object, optional)
- `is_shared` (`put/api/analytics/saved-queries/id.is_shared`; boolean, optional)

## Example request

```json
{
  "name": "string",
  "description": "string",
  "query_config": {},
  "sql_query": "string",
  "visualization_config": {},
  "is_shared": true
}
```

## Code samples

### cURL

```bash
curl --request PUT \
  --url 'https://api.channelautomation.com/api/analytics/saved-queries/<id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "description": "string",
  "query_config": {},
  "sql_query": "string",
  "visualization_config": {},
  "is_shared": true
}
'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/analytics/saved-queries/<id>';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'string',
    description: 'string',
    query_config: {},
    sql_query: 'string',
    visualization_config: {},
    is_shared: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/analytics/saved-queries/<id>"

payload = {
    "name": "string",
    "description": "string",
    "query_config": {},
    "sql_query": "string",
    "visualization_config": {},
    "is_shared": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 200

Query updated successfully

#### Example

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "string",
  "user_email": "string",
  "name": "string",
  "description": "string",
  "query_config": {},
  "sql_query": "string",
  "visualization_config": {},
  "is_shared": true,
  "execution_count": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

- `id` (`put/api/analytics/saved-queries/id.response.200.id`; string, optional)
  - format `uuid`
- `workspace_id` (`put/api/analytics/saved-queries/id.response.200.workspace_id`; string, optional)
- `user_email` (`put/api/analytics/saved-queries/id.response.200.user_email`; string, optional)
- `name` (`put/api/analytics/saved-queries/id.response.200.name`; string, optional)
- `description` (`put/api/analytics/saved-queries/id.response.200.description`; string, optional)
- `query_config` (`put/api/analytics/saved-queries/id.response.200.query_config`; object, optional)
- `sql_query` (`put/api/analytics/saved-queries/id.response.200.sql_query`; string, optional)
- `visualization_config` (`put/api/analytics/saved-queries/id.response.200.visualization_config`; object, optional)
- `is_shared` (`put/api/analytics/saved-queries/id.response.200.is_shared`; boolean, optional)
- `execution_count` (`put/api/analytics/saved-queries/id.response.200.execution_count`; integer, optional)
- `created_at` (`put/api/analytics/saved-queries/id.response.200.created_at`; string, optional)
  - format `date-time`
- `updated_at` (`put/api/analytics/saved-queries/id.response.200.updated_at`; string, optional)
  - format `date-time`

### 400

Invalid request or workspace required

#### Example

```json
{
  "error": "string",
  "details": "string"
}
```

- `error` (`put/api/analytics/saved-queries/id.response.400.error`; string, optional)
- `details` (`put/api/analytics/saved-queries/id.response.400.details`; string, optional)

### 403

Not authorized to edit this query

#### Example

```json
{
  "error": "string",
  "details": "string"
}
```

- `error` (`put/api/analytics/saved-queries/id.response.403.error`; string, optional)
- `details` (`put/api/analytics/saved-queries/id.response.403.details`; string, optional)

### 404

Query not found

#### Example

```json
{
  "error": "string",
  "details": "string"
}
```

- `error` (`put/api/analytics/saved-queries/id.response.404.error`; string, optional)
- `details` (`put/api/analytics/saved-queries/id.response.404.details`; string, optional)

### 500

Server error

#### Example

```json
{
  "error": "string",
  "details": "string"
}
```

- `error` (`put/api/analytics/saved-queries/id.response.500.error`; string, optional)
- `details` (`put/api/analytics/saved-queries/id.response.500.details`; string, optional)


Source: https://developer.channelautomations.com/api/put-api-analytics-saved-queries-id/index.md