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
}
'

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