Create forms from CSV

curl --request POST \
  --url https://app.azalt.co/api/v1/forms/import-csv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "forms": [
    {
      "name": "<string>",
      "siteIds": [
        "<string>"
      ],
      "years": [
        123
      ],
      "elements": [
        {
          "key": "<string>",
          "label": "<string>",
          "type": "NUMBER",
          "optionValues": [
            "<string>"
          ],
          "optionLabels": [
            "<string>"
          ],
          "datasetItems": [
            "<string>"
          ],
          "description": "<string>",
          "placeholder": "<string>",
          "unit": "<string>",
          "unitId": "<string>",
          "required": true,
          "period": "YEARLY",
          "metadata": {}
        }
      ],
      "tags": [
        "<string>"
      ]
    }
  ]
}
'

[
  {
    "id": "<string>",
    "name": "<string>"
  }
]

Form

Create forms from CSV

Bulk create multiple forms from a structured CSV template, ideal for large-scale deployments. Requires site manager permissions.

CSV Format Requirements:

Form Definition Columns: name, description, instructions
Element Columns: element_type, element_label, element_key, element_required, element_options
Deployment Columns: site_ids, year, period_type
Configuration Columns: public_access, password_protected, metadata

Supported Element Types: All 11 form element types supported by the platform

Batch Processing Features:

Multiple forms created in a single operation
Automatic element key generation for consistency
Site deployment across multiple locations
Validation and error reporting for each row

Use Cases:

Deploying standardized forms across multiple sites
Migrating forms from external systems
Creating template-based form libraries
Rapid deployment for compliance requirements
Scaling data collection to hundreds of locations

Error Handling:

Row-by-row validation with detailed error messages
Partial success handling (some forms created, others failed)
Preview mode to validate before actual creation
Rollback options for failed batch operations

POST

forms

import-csv

Create forms from CSV

curl --request POST \
  --url https://app.azalt.co/api/v1/forms/import-csv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "forms": [
    {
      "name": "<string>",
      "siteIds": [
        "<string>"
      ],
      "years": [
        123
      ],
      "elements": [
        {
          "key": "<string>",
          "label": "<string>",
          "type": "NUMBER",
          "optionValues": [
            "<string>"
          ],
          "optionLabels": [
            "<string>"
          ],
          "datasetItems": [
            "<string>"
          ],
          "description": "<string>",
          "placeholder": "<string>",
          "unit": "<string>",
          "unitId": "<string>",
          "required": true,
          "period": "YEARLY",
          "metadata": {}
        }
      ],
      "tags": [
        "<string>"
      ]
    }
  ]
}
'

[
  {
    "id": "<string>",
    "name": "<string>"
  }
]

Authorizations

Authorization

string

header

required

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

Body

application/json

forms

object[]

required

Show child attributes

forms.name

string

required

forms.siteIds

string[]

required

forms.years

number[]

required

forms.elements

object[]

required

Show child attributes

forms.elements.key

string

required

forms.elements.label

string

required

forms.elements.type

enum<string>

required

Available options:

NUMBER,

SHORT_TEXT,

LONG_TEXT,

SINGLE_CHOICE,

MULTIPLE_CHOICE

forms.elements.optionValues

string[]

forms.elements.optionLabels

string[]

forms.elements.datasetItems

string[]

forms.elements.description

string

forms.elements.placeholder

string

forms.elements.unit

string

forms.elements.unitId

string

forms.elements.required

boolean

forms.elements.period

enum<string>

Available options:

YEARLY,

MONTHLY,

QUARTERLY

forms.elements.metadata

object

Show child attributes

forms.elements.metadata.{key}

any

forms.tags

string[]

Response

Successful response

string

required

name

string

required

Get form summary Duplicate form

⌘I

Activity

ActivityDefinition

ApiKey

Dashboard

Widget

DatasetItem

Dataset

File

Form

FormElement

FormElementSubmission

FormSubmission

FormSite

Indicator

Organization

Site

Target

Benchmark

Unit

User

Create forms from CSV

Authorizations

Body

Response