Update form elements

curl --request PUT \
  --url https://app.azalt.co/api/v1/form-elements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formId": "<string>",
  "elements": [
    {
      "id": "<string>",
      "key": "<string>",
      "label": "<string>",
      "required": true,
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "conditions": [
        {
          "id": "<string>",
          "type": "CONDITION",
          "field": "<string>",
          "operator": "equals",
          "value": "<string>",
          "aggregator": "SINGLE"
        }
      ],
      "config": {
        "type": "SHORT_TEXT",
        "description": "<string>",
        "tooltip": "<string>",
        "inlineChoiceDisplay": true,
        "placeholder": "<string>",
        "minLength": 123,
        "maxLength": 123,
        "pattern": "<string>"
      },
      "type": "NUMBER",
      "unitId": "<string>",
      "parentElementId": "<string>",
      "period": "MONTHLY",
      "activityDefinitionId": "<string>",
      "distributionMode": "total",
      "metadata": {}
    }
  ],
  "periodChangeHandling": {
    "action": "delete"
  }
}
'

{
  "success": true
}

FormElement

Update form elements

Bulk update form element configurations across multiple forms. Requires site manager permissions.

Update Capabilities:

Element Properties: Labels, descriptions, validation rules, default values
Options Management: For dropdown, checkbox, and radio elements
Validation Rules: Required status, min/max values, pattern matching
Conditional Logic: Show/hide rules and dependencies
Metadata: Custom attributes and categorization

Update Strategies:

replace: Completely replace element configurations
merge: Update specified properties while preserving others
append: Add new options or rules to existing configurations

Affected Systems:

Active Forms: Changes apply immediately to deployed forms
Existing Submissions: Historical data preserved, new validations apply forward
Calculated Fields: Expressions recalculated with updated dependencies
Conditional Logic: Visibility rules re-evaluated across all forms

Safety Features:

Validation against existing submission data
Preview mode to test changes before applying
Rollback capability for problematic updates
Audit logging for all element modifications

Common Use Cases:

Standardizing element configurations across forms
Updating validation rules organization-wide
Refreshing dropdown options from external data sources
Applying regulatory changes to compliance forms

PUT

form-elements

Update form elements

curl --request PUT \
  --url https://app.azalt.co/api/v1/form-elements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formId": "<string>",
  "elements": [
    {
      "id": "<string>",
      "key": "<string>",
      "label": "<string>",
      "required": true,
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "conditions": [
        {
          "id": "<string>",
          "type": "CONDITION",
          "field": "<string>",
          "operator": "equals",
          "value": "<string>",
          "aggregator": "SINGLE"
        }
      ],
      "config": {
        "type": "SHORT_TEXT",
        "description": "<string>",
        "tooltip": "<string>",
        "inlineChoiceDisplay": true,
        "placeholder": "<string>",
        "minLength": 123,
        "maxLength": 123,
        "pattern": "<string>"
      },
      "type": "NUMBER",
      "unitId": "<string>",
      "parentElementId": "<string>",
      "period": "MONTHLY",
      "activityDefinitionId": "<string>",
      "distributionMode": "total",
      "metadata": {}
    }
  ],
  "periodChangeHandling": {
    "action": "delete"
  }
}
'

{
  "success": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

formId

string

required

elements

object[]

required

Show child attributes

elements.id

string

required

elements.key

string

required

elements.label

string

required

elements.required

boolean

required

elements.options

object[] | null

required

Show child attributes

elements.options.label

string

required

elements.options.value

string

required

elements.options.description

string | null

elements.conditions

object[] | null

required

Option 1
Option 2

Show child attributes

elements.conditions.id

string

required

elements.conditions.type

enum<string>

required

Available options:

CONDITION

elements.conditions.field

string

required

elements.conditions.operator

enum<string>

required

Available options:

equals,

not_equals,

contains,

not_contains,

greater_than,

less_than,

is_not_empty,

is_empty

elements.conditions.value

string

required

elements.conditions.aggregator

enum<string>

default:SINGLE

Available options:

SINGLE,

ANY,

ALL,

SUM,

AVERAGE

elements.config

object

required

Show child attributes

elements.config.type

enum<string>

required

Available options:

SHORT_TEXT

elements.config.description

string

elements.config.inlineChoiceDisplay

boolean

elements.config.placeholder

string

elements.config.minLength

number

elements.config.maxLength

number

elements.config.pattern

string

elements.type

enum<string>

required

Available options:

NUMBER,

ACTIVITY,

SHORT_TEXT,

LONG_TEXT,

SINGLE_CHOICE,

MULTIPLE_CHOICE,

FILE_UPLOAD,

IMAGE,

GROUP,

PAGE,

TITLE,

PARAGRAPH,

DIVIDER

elements.unitId

string | null

required

elements.parentElementId

string | null

required

elements.period

enum<string>

required

Available options:

MONTHLY,

QUARTERLY,

YEARLY,

TIMESTAMP

elements.activityDefinitionId

string | null

elements.distributionMode

enum<string> | null

Available options:

total,

snapshot,

elements.metadata

object

Show child attributes

elements.metadata.{key}

periodChangeHandling

object

Show child attributes

periodChangeHandling.action

enum<string>

required

Available options:

delete

Response

Successful response

success

boolean

required

List form elements List form elements by form ID

⌘I

Activity

ActivityDefinition

ApiKey

Dashboard

Widget

DatasetItem

Dataset

File

Form

FormElement

FormElementSubmission

FormSubmission

FormSite

Indicator

Organization

Site

Target

Benchmark

Unit

User

Update form elements

Authorizations

Body

Response