Skip to main content
PATCH
/
datasets
/
{dataset_id}
Update Dataset
curl --request PATCH \
  --url https://api.example.com/datasets/{dataset_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "starred": true,
  "import_config": {
    "integration_config": {
      "domain": "<string>",
      "query_type": "soql",
      "query": "<string>",
      "source": "salesforce"
    },
    "credential_secret": "<string>",
    "output_dataset": "<string>",
    "job_type": "integration"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "detailed_description": "<string>",
  "organisation_id": "<string>",
  "status": "<string>",
  "starred": true,
  "is_primary": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "columns": [
    "<string>"
  ],
  "is_embedding_searchable": true,
  "dictionary": {},
  "dataset_schema": {
    "column_schemas": {}
  },
  "annotations": {},
  "warehousing_error": "<string>",
  "cron_schedule": "<string>",
  "schedule_enabled": true,
  "last_schedule_run_at": "2023-11-07T05:31:56Z",
  "import_config": {},
  "is_importing": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key
string | null

Path Parameters

dataset_id
string<uuid>
required

Body

application/json
name
string | null
description
string | null
starred
boolean | null
import_config
IntegrationConfig · object

Response

Successful Response

id
string<uuid>
required
name
string
required
description
string | null
required
detailed_description
string | null
required
organisation_id
string
required
status
string
required
starred
boolean
required
is_primary
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
columns
string[]
required
is_embedding_searchable
boolean
required
dictionary
Dictionary · object
dataset_schema
DatasetSchema · object
annotations
Annotations · object
warehousing_error
string | null
cron_schedule
string | null
schedule_enabled
boolean | null
last_schedule_run_at
string<date-time> | null
import_config
Import Config · object
is_importing
boolean | null