Create a conditional field

curl --request POST \ --url https://your-instance.example.com/api/organizations/{organizationId}/conditional-fields \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Eligibility flag", "sectionId": "contact.identity", "expression": "contact.age >= 18 && contact.country == \"US\"", "status": "active", "outputType": "boolean", "description": "Set true when contact passes US adult eligibility checks", "type": "contact", "sectionType": "identity" } '

{ "_id": "66d0a0b0c0d0e0f0a0b0c0d0", "name": "Eligibility flag", "sectionId": "contact.identity", "expression": "contact.age >= 18 && contact.country == \"US\"", "status": "active", "outputType": "boolean" }

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationId

string

required

Body

application/json

name

string

required

Display name of the conditional field; shown in catalogs and UI.

sectionId

string

required

Catalog section the field belongs to (e.g. contact.identity).

expression

string

required

Evaluator expression (e.g. contact.age >= 18 && contact.country == "US"). Validated against the catalog on save.

status

string

Lifecycle state of the field, typically active or draft.

outputType

string

Type returned by the expression: boolean, string, number.

description

string

Free-form explanation of the field's intent; shown as helper text.

type

string

Top-level scope the field applies to (e.g. contact, application).

sectionType

string

Where the field is surfaced (contact, application, etc.).

Response

Field created

The response is of type object.