Update Property for Timeline Event Type

PUT /integrations/v1/:application-id/timeline/event-types/:event-type-id/properties

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Update an existing property for a specified timeline event type. The id passed in the JSON body needs to match the id of an existing property or this will return a 404 error.  Properties cannot be moved from one event type to another, so the eventTypeId included in the JSON body must match the event-type-id in the URL. Please note that the name cannot be updated.
Required Parameters How to use Description
 hapikey= Used in the request URL Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
 application-id Used in the request URL The ID of the application that the event type belongs to.
event-type-id Used in the request URL The ID of the event type that you want to update the property for.
 id Used in the request JSON body The ID of the property you want to update.

Optional Parameters How to use Description
propertyType Used in the request JSON body. The type of information that will be stored in this property. This must be one of the following: Date, Enumeration, Numeric, or String.
label Used in the request JSON body. The label used to display the property in the user interface.
options Used in the request JSON body. An array with all the possible options that the specific property accepts. If it is not provided, the existing options will remain in place. Important! Including any value for this property will overwrite the exisitng options.  It is not possible to append a single new option.