Skip to main content
POST
Create Field Configuration

Authorizations

Authorization
string
header
required

Body

Field configuration to create.

Request payload for creating a new field configuration. The owning organization is inferred from the API key - any organization UUID included in the body is ignored.

name
string
required

Human-readable name of the configuration. Trimmed; 1-128 characters.

Example:

"Enterprise Discovery Questions"

teamsUUID
string[]

UUIDs of the teams to assign this configuration to. Ignored when allTeams is true.

Example:
allTeams
boolean

When true, the configuration applies to every team in the organization.

Example:

false

criteria
object

Criteria expression that controls when this field configuration applies. Conditions are combined using the specified boolean operator.

Example:

Response

Field configuration created successfully.

Envelope containing a single field configuration.

data
object

A Field Configuration (internally IntelligenceItemCollection) groups a set of intelligence items that are surfaced together for the teams it is assigned to. Field Configurations are scoped to a single organization.

Example: