Update an event type

Request

Security

ApiKey(Required scopes: eventTypes.update)

Path

idstringrequired

ID of the event type

Bodyapplication/jsonrequired

non-empty

namestring, [ 1 .. 32 ] characters

Name of the event type

colorNamestring, [ 1 .. 32 ] characters

Color name of the event type, e.g. "red"

customPropertiesArray of objects(EventTypeCustomProperty)

Ordered array of custom properties associated with the event type. This will replace the existing customProperties list.

Payload

{
  "name": "string",
  "colorName": "string",
  "customProperties": [
    { … }
  ]
}

Responses

The updated event type

Bodyapplication/json

idstringrequired

ID of the event type

namestringrequired

Name of the event type

createdAtstring, (date-time)required

When the event type was created

updatedAtstring, (date-time)required

When the event type was last updated

colorNamestring

Color name of the event type, e.g. "red"

customPropertiesArray of objects(EventTypeCustomProperty)

Ordered array of custom properties associated with the event type

Response

{
  "id": "string",
  "name": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "colorName": "string",
  "customProperties": [
    { … }
  ]
}