Skip to main content
PATCH
/
data_stream_property_definitions
/
{id}
Update a property definition
curl --request PATCH \
  --url https://api.endclose.com/v1/data_stream_property_definitions/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "optional": true
}
'
{
  "key": "<string>",
  "name": "<string>",
  "type": "number",
  "data_stream_key": "<string>",
  "id": 123,
  "optional": false
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
name
string
​
optional
boolean

Response

200 - application/json

Property definition updated

​
key
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
number,
date,
datetime,
string
​
data_stream_key
string
required

Must match an existing DataStream.key

​
id
integer
​
optional
boolean
default:false