Update a property definition

Changed on

Update the name or optional flag of a property definition.

patch/data_stream_property_definitions/{id}

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

Request body

namestring
optionalboolean

Response

Property definition updated

idstring uuid
keystring required
namestring required
type'number' | 'date' | 'datetime' | 'string' | 'boolean' required
optionalboolean
data_stream_keystring required

Must match an existing DataStream.key

Changes

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status