Skip to main content
PATCH
/
attributes
/
{id}
Update an attribute
curl --request PATCH \
  --url https://api.breakcold.com/rest/attributes/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "select_options": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>"
    }
  ]
}'
{
  "type": "TEXT",
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isMultiSelect": true,
  "isSystem": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "id_space": "<string>",
  "attribute_definitions_select_options_order": [
    "<string>"
  ],
  "object_definitionsId": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
slug
string
Required string length: 1 - 255
​
description
string | null
Maximum length: 255
​
currency
string
​
select_options
object[]

Response

Successful response

​
type
enum<string>
required
Available options:
TEXT,
TEXTAREA,
NUMBER,
EMAIL,
CHECKBOX,
DATE,
TIMESTAMP,
SELECT,
CURRENCY,
LOCATION,
PHONENUMBER,
RELATION
​
id
string
required
​
slug
string
required
​
name
string
required
​
description
string | null
required
​
isMultiSelect
boolean | null
required
​
isSystem
boolean | null
required
​
created_at
string
required
​
updated_at
string
required
​
id_space
string | null
required
​
attribute_definitions_select_options_order
string[]
required
​
object_definitionsId
string | null
required