Update DataSet Details

Updates the specified DataSet’s metadata by providing values to parameters passed.

Appending Data

To import additional rows into an existing DataSet, use the DataSet Import endpoint or the Simple API.

PUT /v1/datasets/{dataset_id}

Update DataSet Details

cURL

curl --request PUT \
  --url https://api.domo.com/v1/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Leonhard Euler Birthday Bash",
  "description": "VIP Guest List",
  "pdpEnabled": true
}
'

import requests

url = "https://api.domo.com/v1/datasets/{dataset_id}"

payload = {
    "name": "Leonhard Euler Birthday Bash",
    "description": "VIP Guest List",
    "pdpEnabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Leonhard Euler Birthday Bash',
    description: 'VIP Guest List',
    pdpEnabled: true
  })
};

fetch('https://api.domo.com/v1/datasets/{dataset_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.domo.com/v1/datasets/{dataset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Leonhard Euler Birthday Bash',
    'description' => 'VIP Guest List',
    'pdpEnabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.domo.com/v1/datasets/{dataset_id}"

	payload := strings.NewReader("{\n  \"name\": \"Leonhard Euler Birthday Bash\",\n  \"description\": \"VIP Guest List\",\n  \"pdpEnabled\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.domo.com/v1/datasets/{dataset_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Leonhard Euler Birthday Bash\",\n  \"description\": \"VIP Guest List\",\n  \"pdpEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.domo.com/v1/datasets/{dataset_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Leonhard Euler Birthday Bash\",\n  \"description\": \"VIP Guest List\",\n  \"pdpEnabled\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "4405ff58-1957-45f0-82bd-914d989a3ea3",
  "name": "Leonhard Euler Birthday Bash",
  "description": "VIP Guest List",
  "rows": 0,
  "columns": 0,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "Friend"
      },
      {
        "type": "STRING",
        "name": "Attending"
      }
    ]
  },
  "owner": {
    "id": 27,
    "name": "DomoSupport"
  },
  "createdAt": "2016-06-21T17:20:36Z",
  "updatedAt": "2016-06-21T17:48:41Z",
  "pdpEnabled": true,
  "policies": [
    {
      "id": 8,
      "type": "user",
      "name": "Only Show Attendees",
      "filters": [
        {
          "column": "Attending",
          "values": [
            "TRUE"
          ],
          "operator": "EQUALS",
          "not": false
        }
      ],
      "users": [
        27
      ],
      "groups": []
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

dataset_id · string · required

The ID of the DataSet

Body

application/json

name · string

Name of the DataSet to update

description · string

Description of DataSet to update

pdpEnabled · boolean

schema · object

The current schema associated with this DataSet

Show child attributes

Response

200 - application/json

Successful response

id · string

name · string

description · string

rows · integer

columns · integer

schema · object

Show child attributes

owner · object

Show child attributes

createdAt · string

updatedAt · string

pdpEnabled · boolean

policies · object[]

Show child attributes