PATCH
/
event_schema
/
{event_schema_name}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

event_schema_name
string
required

Body

application/json
description
string

Description of the event

attributes
object[]
dimensions
object[]
enrichments
object
filterFields
string[]

List of fields that can be used for filtering in usage meter

eventIdTemplate
string

Template used to generate event id based on event payload

Response

200 - application/json
name
string
required

Name of the event. Must be unique for an organization.

description
string

Description of the event

version
integer
required

Version of event schema

status
enum<string>

Status of event schema

  • DRAFT - Schema is in draft state
  • ACTIVE - Schema is currently active
  • INACTIVE - Schema is currently inactive
  • ARCHIVED - Older version of event schema
Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
attributes
object[]
dimensions
object[]
filterFields
string[]
featureDetails
object

details of feature associated with event schema with attribute name

enrichments
object
eventIdTemplate
string

Template used to generate event id based on event payload

eventLevelRevenue
boolean
createdAt
string
updatedAt
string