PATCH
/
lists
/
{id}
curl --request PATCH \
  --url https://api.breakcold.com/rest/lists/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "schema": "<any>",
  "attribute_definitions_order": [
    "<string>"
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "order": 123,
  "emoji": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "can_be_delete": true,
  "deleted_at": "2023-11-07T05:31:56Z",
  "is_deleted": true,
  "favorite": true,
  "schema": "<string>",
  "id_space": "<string>",
  "attribute_definitions_order": [
    "<string>"
  ]
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Body

application/json
name
string
Required string length: 1 - 255
description
string
Required string length: 1 - 255
emoji
string | null
Required string length: 1 - 255
schema
any
attribute_definitions_order
string[]

Response

200
application/json
Successful response
id
string
required
name
string | null
required
order
integer | null
required
emoji
string | null
required
description
string | null
required
created_at
string
required
updated_at
string | null
required
can_be_delete
boolean | null
required
deleted_at
string | null
required
is_deleted
boolean
required
favorite
boolean | null
required
schema
required
id_space
string | null
required
attribute_definitions_order
string[]
required