Docs

Update Event Attribute

PUT /Organizations/{organizationId}/eventAttributes/{attributeId}

PUT/Organizations/{organizationId}/eventAttributes/{attributeId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Updates an existing event attribute definition. Options are managed as a full replacement with smart diffing: options with an id are updated in place, options without an id are created as new, and any existing options omitted from the request are deleted.

Requires OrganizationAdmin permission.

Path Parameters

FieldTypeRequiredDescription
organizationIdGuidRequiredThe organization that owns the attribute.
attributeIdGuidRequiredThe attribute to update.

Request Body

FieldTypeRequiredDescription
namestringRequiredDisplay name of the attribute.
typestringRequiredAttribute type.
isRequiredboolRequiredWhether this attribute is required on events.
optionsOption[]OptionalFull options list (replaces existing).

Option

FieldTypeRequiredDescription
idGuid?OptionalProvide to update an existing option; omit to create a new one.
valuestringRequiredDisplay value.
colorstringRequiredHex color for the option badge.