Create a list

Creates a new list within the given project id.

POST /v1/projects/{PROJECT_ID}/lists

Create a list

cURL

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

200

{
  "id": "13",
  "name": "Needs Validation",
  "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

Query Parameters

name · string · required

The name of the List

type · string · required

The type of List (i.e. TODO, WORKING_ON, COMPLETED)

index · integer

The ordered index of the list within the project. Setting this property will re-order other lists in the project to maintain sequential order. Leaving this property blank will default the index to 1 and shift the index of all other lists.

Body

application/json

The request body accepts a list object.

name · string

type · string

index · integer

Response

200 - application/json

Returns a list object when successful.

id · string

name · string

type · string

index · integer