/api/v1/lists/{id} (PATCH)

PATCH

/api/v1/lists/{id}

curl --request PATCH \
  --url https://example.com/api/v1/lists/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example" }'

Parameters

Path Parameters

id

required

string format: uuid

Request Body

Media type application/json

object

title

required

string

>= 1 characters <= 200 characters

Example ^generated

{
  "title": "example"
}

Responses

200

Updated

Media type application/json

object

id

required

string format: uuid

title

required

string

>= 1 characters <= 200 characters

ownerId

required

string

isOwned

required

boolean

rank

required

string

>= 1 characters

groupId

required

string | null format: uuid

createdAt

required

string

updatedAt

required

string

deletedAt

string

shared

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "title": "example",
  "ownerId": "example",
  "isOwned": true,
  "rank": "example",
  "groupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "createdAt": "example",
  "updatedAt": "example",
  "deletedAt": "example",
  "shared": true
}

401

No valid session

Media type application/problem+json

object

type

required

string

title

required

string

status

required

number

code

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example"
}

404

Not found

Media type application/problem+json

object

type

required

string

title

required

string

status

required

number

code

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example"
}

409

Idempotency-Key reused with a different request

Media type application/problem+json

object

type

required

string

title

required

string

status

required

number

code

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example"
}