Skip to main content
POST
/
status
Create a status
curl --request POST \
  --url https://api.breakcold.com/rest/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "id_list": "<string>",
  "color": "<string>",
  "success_rate": 50,
  "ai_enabled": true,
  "order": 123,
  "type": "DEAL_LOST"
}'
{
  "type": "DEAL_WON",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "order": 123,
  "color": "<string>",
  "success_rate": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "id_space": "<string>",
  "leads_order": "<any>",
  "ai_instructions": "<any>",
  "ai_rules": "<any>",
  "ai_instructions_text": "<string>",
  "ai_rules_text": "<string>",
  "ai_enabled": true,
  "icon": "<string>",
  "instructions": "<string>",
  "id_list": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
id_list
string
​
color
string
​
success_rate
number
Required range: 0 <= x <= 100
​
ai_enabled
boolean
​
order
integer
​
type
Available options:
DEAL_LOST,
DEAL_WON

Response

Successful response

​
type
enum<string> | null
required
Available options:
DEAL_WON,
DEAL_LOST
​
id
string<uuid>
required
​
name
string | null
required
​
order
integer | null
required
​
color
string | null
required
​
success_rate
integer | null
required
​
created_at
string | null
required
​
updated_at
string | null
required
​
id_space
string | null
required
​
leads_order
any
​
ai_instructions
any
​
ai_rules
any
​
ai_instructions_text
string | null
​
ai_rules_text
string | null
​
ai_enabled
boolean | null
​
icon
string | null
​
instructions
string | null
​
id_list
string | null