POST
/
lists
Create a list
curl --request POST \
  --url https://api.breakcold.com/rest/lists \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "emoji": "<string>",
  "description": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "order": 123,
  "emoji": "<string>",
  "description": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "can_be_delete": true,
  "deleted_at": "<string>",
  "is_deleted": true,
  "favorite": true,
  "id_space": "<string>",
  "attribute_definitions_order": [
    "<string>"
  ],
  "ai_instructions": "<any>",
  "ai_rules": "<any>",
  "ai_instructions_text": "<string>",
  "ai_rules_text": "<string>",
  "ai_enabled": true
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 255
emoji
string | null
Required string length: 1 - 255
description
string
Required string length: 1 - 255

Response

Successful response

id
string<uuid>
name
string | null
order
integer | null
emoji
string | null
description
string | null
created_at
string
updated_at
string | null
can_be_delete
boolean | null
deleted_at
string | null
is_deleted
boolean
favorite
boolean | null
id_space
string | null
attribute_definitions_order
string[]
ai_instructions
any
ai_rules
any
ai_instructions_text
string | null
ai_rules_text
string | null
ai_enabled
boolean | null