Sign in
Rules

Create a rule

Create a rule that defines constraints and requirements for the participant pool

post/participant-pools/{participantPoolId}/rules

Request body

idstring

Unique identifier for the rule

namestring required

Human-readable rule name (e.g., "department", "experience_years")

descriptionstring

Detailed description of what this rule validates

dataType'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' required

Data type for participant pool rule values

selectionMode'SINGLE' | 'MULTIPLE' | 'RANGE' | 'FREEFORM' required

Selection mode for participant pool rule values

createdAtstring date-time

Timestamp when the rule was created

updatedAtstring date-time

Timestamp when the rule was last updated

isEditableboolean

Whether this rule is editable

Response

Rule created successfully

idstring

Unique identifier for the rule

namestring required

Human-readable rule name (e.g., "department", "experience_years")

descriptionstring

Detailed description of what this rule validates

dataType'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' required

Data type for participant pool rule values

selectionMode'SINGLE' | 'MULTIPLE' | 'RANGE' | 'FREEFORM' required

Selection mode for participant pool rule values

createdAtstring date-time

Timestamp when the rule was created

updatedAtstring date-time

Timestamp when the rule was last updated

isEditableboolean

Whether this rule is editable

Changes

No recorded changes to this endpoint across all 1 revision of this API.