Update a list

Update the details of a list given an existing project id and list id.

PUT /v1/projects/{PROJECT_ID}/lists/{LIST_ID}

Update a list

cURL

curl --request PUT \
  --url https://api.domo.com/v1/projects/{PROJECT_ID}/lists/{LIST_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Needs QA",
  "type": "TODO",
  "index": 3
}
'

import requests

url = "https://api.domo.com/v1/projects/{PROJECT_ID}/lists/{LIST_ID}"

payload = {
    "name": "Needs QA",
    "type": "TODO",
    "index": 3
}
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: 'Needs QA', type: 'TODO', index: 3})
};

fetch('https://api.domo.com/v1/projects/{PROJECT_ID}/lists/{LIST_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/projects/{PROJECT_ID}/lists/{LIST_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' => 'Needs QA',
    'type' => 'TODO',
    'index' => 3
  ]),
  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/projects/{PROJECT_ID}/lists/{LIST_ID}"

	payload := strings.NewReader("{\n  \"name\": \"Needs QA\",\n  \"type\": \"TODO\",\n  \"index\": 3\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/projects/{PROJECT_ID}/lists/{LIST_ID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Needs QA\",\n  \"type\": \"TODO\",\n  \"index\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.domo.com/v1/projects/{PROJECT_ID}/lists/{LIST_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\": \"Needs QA\",\n  \"type\": \"TODO\",\n  \"index\": 3\n}"

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

200

{
  "id": "13",
  "name": "Needs QA",
  "type": "TODO",
  "index": 3
}

Authorizations

Authorization · string · header · required

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

Path Parameters

PROJECT_ID · string · required

The ID of the project

LIST_ID · string · required

The ID of the list

Query Parameters

name · string · required

Updated name of the list

type · string · required

One of the following strings TODO, WORKING_ON, COMPLETED.

index · integer · required

The updated index of the list within the project. Updating the index of a list may also change the order of the other lists in the project to remain sequential.

Body

application/json

The request body accepts a list object.

name · string

type · string

index · integer

Response

200 - application/json

Returns the updated list object.

id · string

name · string

type · string

index · integer