Docs

Add Event Attribute

POST /Organizations/{organizationId}/eventAttributes

POST/Organizations/{organizationId}/eventAttributes

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.

Creates a new custom attribute definition for the organization. Options are only relevant for Select and MultiSelect attribute types.

Requires OrganizationAdmin permission.

Path Parameters

FieldTypeRequiredDescription
organizationIdGuidRequiredThe organization to add the attribute to.

Request Body

FieldTypeRequiredDescription
namestringRequiredDisplay name of the attribute.
typestringRequiredAttribute type (`Select`, `MultiSelect`, `Text`, `RichText`, `Number`, `Date`, `DateTime`, `Checkbox`, `Link`).
isRequiredboolRequiredWhether this attribute must be set when creating an event.
optionsOption[]OptionalOptions for `Select`/`MultiSelect` types.

Option

FieldTypeRequiredDescription
valuestringRequiredDisplay value of the option.
colorstringRequiredHex color for the option badge.