/v0/lists/:id (PATCH)

PATCH

/v0/lists/:id

const url = 'http://localhost:3000/v0/lists/:id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"title":"Pulsate developers","public":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url http://localhost:3000/v0/lists/:id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "Pulsate developers", "public": false }'

Authorizations

bearer

Parameters

Path Parameters

required

string

Request Body

application/json

object

title

List title

string

Example

Pulsate developers

public

If true, list is public

boolean

Example

false

Responses

200

application/json

object

required

List ID

string

title

required

List title

string

public

If true, list is public

boolean

Example

{
  "id": "38477395",
  "title": "Pulsate developers",
  "public": false
}

400

List title too long

application/json

List title too long

object

error

required

List title is too long

string

Allowed values: TITLE_TOO_LONG

Example

{
  "error": "TITLE_TOO_LONG"
}

404

List not found

application/json

object

error

required

List not found

string

Allowed values: LIST_NOT_FOUND

Example

{
  "error": "LIST_NOT_FOUND"
}

500

Internal error

application/json

Internal server error

object

error

required

Internal server error

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}