Update form

curl --request PUT \
  --url https://app.azalt.co/api/v1/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isPublic": true,
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "alternativeNames": [
    "<string>"
  ],
  "showOrganizationLogo": true,
  "headerBgColor": "<string>",
  "logoWidth": 123,
  "headerPaddingTop": 123,
  "headerPaddingBottom": 123,
  "settings": {
    "allowPublicSubmissionEdits": true,
    "allowPublicSubmissionSupportingDocuments": true,
    "workflowOverride": {},
    "defaultSchedules": {
      "MONTHLY": {},
      "QUARTERLY": {},
      "YEARLY": {}
    },
    "allowedEmailDomains": [
      "<string>"
    ],
    "requireUniqueEmailDomain": true,
    "requireUniqueEmailAddress": true,
    "hideFuturePeriodsOverride": true
  },
  "metadata": {}
}
'

import requests

url = "https://app.azalt.co/api/v1/forms/{id}"

payload = {
    "isPublic": True,
    "name": "<string>",
    "description": "<string>",
    "tags": ["<string>"],
    "alternativeNames": ["<string>"],
    "showOrganizationLogo": True,
    "headerBgColor": "<string>",
    "logoWidth": 123,
    "headerPaddingTop": 123,
    "headerPaddingBottom": 123,
    "settings": {
        "allowPublicSubmissionEdits": True,
        "allowPublicSubmissionSupportingDocuments": True,
        "workflowOverride": {},
        "defaultSchedules": {
            "MONTHLY": {},
            "QUARTERLY": {},
            "YEARLY": {}
        },
        "allowedEmailDomains": ["<string>"],
        "requireUniqueEmailDomain": True,
        "requireUniqueEmailAddress": True,
        "hideFuturePeriodsOverride": True
    },
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isPublic: true,
    name: '<string>',
    description: '<string>',
    tags: ['<string>'],
    alternativeNames: ['<string>'],
    showOrganizationLogo: true,
    headerBgColor: '<string>',
    logoWidth: 123,
    headerPaddingTop: 123,
    headerPaddingBottom: 123,
    settings: {
      allowPublicSubmissionEdits: true,
      allowPublicSubmissionSupportingDocuments: true,
      workflowOverride: {},
      defaultSchedules: {MONTHLY: {}, QUARTERLY: {}, YEARLY: {}},
      allowedEmailDomains: ['<string>'],
      requireUniqueEmailDomain: true,
      requireUniqueEmailAddress: true,
      hideFuturePeriodsOverride: true
    },
    metadata: {}
  })
};

fetch('https://app.azalt.co/api/v1/forms/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.azalt.co/api/v1/forms/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'isPublic' => true,
    'name' => '<string>',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ],
    'alternativeNames' => [
        '<string>'
    ],
    'showOrganizationLogo' => true,
    'headerBgColor' => '<string>',
    'logoWidth' => 123,
    'headerPaddingTop' => 123,
    'headerPaddingBottom' => 123,
    'settings' => [
        'allowPublicSubmissionEdits' => true,
        'allowPublicSubmissionSupportingDocuments' => true,
        'workflowOverride' => [
                
        ],
        'defaultSchedules' => [
                'MONTHLY' => [
                                
                ],
                'QUARTERLY' => [
                                
                ],
                'YEARLY' => [
                                
                ]
        ],
        'allowedEmailDomains' => [
                '<string>'
        ],
        'requireUniqueEmailDomain' => true,
        'requireUniqueEmailAddress' => true,
        'hideFuturePeriodsOverride' => true
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.azalt.co/api/v1/forms/{id}"

	payload := strings.NewReader("{\n  \"isPublic\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"alternativeNames\": [\n    \"<string>\"\n  ],\n  \"showOrganizationLogo\": true,\n  \"headerBgColor\": \"<string>\",\n  \"logoWidth\": 123,\n  \"headerPaddingTop\": 123,\n  \"headerPaddingBottom\": 123,\n  \"settings\": {\n    \"allowPublicSubmissionEdits\": true,\n    \"allowPublicSubmissionSupportingDocuments\": true,\n    \"workflowOverride\": {},\n    \"defaultSchedules\": {\n      \"MONTHLY\": {},\n      \"QUARTERLY\": {},\n      \"YEARLY\": {}\n    },\n    \"allowedEmailDomains\": [\n      \"<string>\"\n    ],\n    \"requireUniqueEmailDomain\": true,\n    \"requireUniqueEmailAddress\": true,\n    \"hideFuturePeriodsOverride\": true\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.azalt.co/api/v1/forms/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isPublic\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"alternativeNames\": [\n    \"<string>\"\n  ],\n  \"showOrganizationLogo\": true,\n  \"headerBgColor\": \"<string>\",\n  \"logoWidth\": 123,\n  \"headerPaddingTop\": 123,\n  \"headerPaddingBottom\": 123,\n  \"settings\": {\n    \"allowPublicSubmissionEdits\": true,\n    \"allowPublicSubmissionSupportingDocuments\": true,\n    \"workflowOverride\": {},\n    \"defaultSchedules\": {\n      \"MONTHLY\": {},\n      \"QUARTERLY\": {},\n      \"YEARLY\": {}\n    },\n    \"allowedEmailDomains\": [\n      \"<string>\"\n    ],\n    \"requireUniqueEmailDomain\": true,\n    \"requireUniqueEmailAddress\": true,\n    \"hideFuturePeriodsOverride\": true\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.azalt.co/api/v1/forms/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isPublic\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"alternativeNames\": [\n    \"<string>\"\n  ],\n  \"showOrganizationLogo\": true,\n  \"headerBgColor\": \"<string>\",\n  \"logoWidth\": 123,\n  \"headerPaddingTop\": 123,\n  \"headerPaddingBottom\": 123,\n  \"settings\": {\n    \"allowPublicSubmissionEdits\": true,\n    \"allowPublicSubmissionSupportingDocuments\": true,\n    \"workflowOverride\": {},\n    \"defaultSchedules\": {\n      \"MONTHLY\": {},\n      \"QUARTERLY\": {},\n      \"YEARLY\": {}\n    },\n    \"allowedEmailDomains\": [\n      \"<string>\"\n    ],\n    \"requireUniqueEmailDomain\": true,\n    \"requireUniqueEmailAddress\": true,\n    \"hideFuturePeriodsOverride\": true\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isPublic": true
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Form

Update form

Update an existing form’s configuration, elements, and deployment settings. Requires site manager permissions.

Updatable Fields:

name: Form title and identifier
description: Purpose and instructions
elements: Complete element configuration (add, modify, remove)
siteIds: Site deployment changes
publicAccess: Enable/disable public submission
passwordProtected: Security settings
metadata: Custom attributes and categorization

Element Modification Impact:

Adding Elements: Retroactively available for all submissions
Removing Elements: Existing data preserved but inaccessible
Changing Types: May cause data compatibility issues
Updating Validation: Affects future submissions only

Best Practices:

Version control: Consider creating new forms for major changes
Data integrity: Test changes against existing submissions
User communication: Notify data collectors of significant changes
Backup: Export form configuration before major updates

Deployment Changes:

Adding sites: Form becomes available to new locations
Removing sites: Existing data preserved, new submissions blocked
Site-specific customization preserved during updates

PUT

forms

{id}

Update form

curl --request PUT \
  --url https://app.azalt.co/api/v1/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isPublic": true,
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "alternativeNames": [
    "<string>"
  ],
  "showOrganizationLogo": true,
  "headerBgColor": "<string>",
  "logoWidth": 123,
  "headerPaddingTop": 123,
  "headerPaddingBottom": 123,
  "settings": {
    "allowPublicSubmissionEdits": true,
    "allowPublicSubmissionSupportingDocuments": true,
    "workflowOverride": {},
    "defaultSchedules": {
      "MONTHLY": {},
      "QUARTERLY": {},
      "YEARLY": {}
    },
    "allowedEmailDomains": [
      "<string>"
    ],
    "requireUniqueEmailDomain": true,
    "requireUniqueEmailAddress": true,
    "hideFuturePeriodsOverride": true
  },
  "metadata": {}
}
'

import requests

url = "https://app.azalt.co/api/v1/forms/{id}"

payload = {
    "isPublic": True,
    "name": "<string>",
    "description": "<string>",
    "tags": ["<string>"],
    "alternativeNames": ["<string>"],
    "showOrganizationLogo": True,
    "headerBgColor": "<string>",
    "logoWidth": 123,
    "headerPaddingTop": 123,
    "headerPaddingBottom": 123,
    "settings": {
        "allowPublicSubmissionEdits": True,
        "allowPublicSubmissionSupportingDocuments": True,
        "workflowOverride": {},
        "defaultSchedules": {
            "MONTHLY": {},
            "QUARTERLY": {},
            "YEARLY": {}
        },
        "allowedEmailDomains": ["<string>"],
        "requireUniqueEmailDomain": True,
        "requireUniqueEmailAddress": True,
        "hideFuturePeriodsOverride": True
    },
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isPublic: true,
    name: '<string>',
    description: '<string>',
    tags: ['<string>'],
    alternativeNames: ['<string>'],
    showOrganizationLogo: true,
    headerBgColor: '<string>',
    logoWidth: 123,
    headerPaddingTop: 123,
    headerPaddingBottom: 123,
    settings: {
      allowPublicSubmissionEdits: true,
      allowPublicSubmissionSupportingDocuments: true,
      workflowOverride: {},
      defaultSchedules: {MONTHLY: {}, QUARTERLY: {}, YEARLY: {}},
      allowedEmailDomains: ['<string>'],
      requireUniqueEmailDomain: true,
      requireUniqueEmailAddress: true,
      hideFuturePeriodsOverride: true
    },
    metadata: {}
  })
};

fetch('https://app.azalt.co/api/v1/forms/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.azalt.co/api/v1/forms/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'isPublic' => true,
    'name' => '<string>',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ],
    'alternativeNames' => [
        '<string>'
    ],
    'showOrganizationLogo' => true,
    'headerBgColor' => '<string>',
    'logoWidth' => 123,
    'headerPaddingTop' => 123,
    'headerPaddingBottom' => 123,
    'settings' => [
        'allowPublicSubmissionEdits' => true,
        'allowPublicSubmissionSupportingDocuments' => true,
        'workflowOverride' => [
                
        ],
        'defaultSchedules' => [
                'MONTHLY' => [
                                
                ],
                'QUARTERLY' => [
                                
                ],
                'YEARLY' => [
                                
                ]
        ],
        'allowedEmailDomains' => [
                '<string>'
        ],
        'requireUniqueEmailDomain' => true,
        'requireUniqueEmailAddress' => true,
        'hideFuturePeriodsOverride' => true
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.azalt.co/api/v1/forms/{id}"

	payload := strings.NewReader("{\n  \"isPublic\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"alternativeNames\": [\n    \"<string>\"\n  ],\n  \"showOrganizationLogo\": true,\n  \"headerBgColor\": \"<string>\",\n  \"logoWidth\": 123,\n  \"headerPaddingTop\": 123,\n  \"headerPaddingBottom\": 123,\n  \"settings\": {\n    \"allowPublicSubmissionEdits\": true,\n    \"allowPublicSubmissionSupportingDocuments\": true,\n    \"workflowOverride\": {},\n    \"defaultSchedules\": {\n      \"MONTHLY\": {},\n      \"QUARTERLY\": {},\n      \"YEARLY\": {}\n    },\n    \"allowedEmailDomains\": [\n      \"<string>\"\n    ],\n    \"requireUniqueEmailDomain\": true,\n    \"requireUniqueEmailAddress\": true,\n    \"hideFuturePeriodsOverride\": true\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.azalt.co/api/v1/forms/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isPublic\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"alternativeNames\": [\n    \"<string>\"\n  ],\n  \"showOrganizationLogo\": true,\n  \"headerBgColor\": \"<string>\",\n  \"logoWidth\": 123,\n  \"headerPaddingTop\": 123,\n  \"headerPaddingBottom\": 123,\n  \"settings\": {\n    \"allowPublicSubmissionEdits\": true,\n    \"allowPublicSubmissionSupportingDocuments\": true,\n    \"workflowOverride\": {},\n    \"defaultSchedules\": {\n      \"MONTHLY\": {},\n      \"QUARTERLY\": {},\n      \"YEARLY\": {}\n    },\n    \"allowedEmailDomains\": [\n      \"<string>\"\n    ],\n    \"requireUniqueEmailDomain\": true,\n    \"requireUniqueEmailAddress\": true,\n    \"hideFuturePeriodsOverride\": true\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.azalt.co/api/v1/forms/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isPublic\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"alternativeNames\": [\n    \"<string>\"\n  ],\n  \"showOrganizationLogo\": true,\n  \"headerBgColor\": \"<string>\",\n  \"logoWidth\": 123,\n  \"headerPaddingTop\": 123,\n  \"headerPaddingBottom\": 123,\n  \"settings\": {\n    \"allowPublicSubmissionEdits\": true,\n    \"allowPublicSubmissionSupportingDocuments\": true,\n    \"workflowOverride\": {},\n    \"defaultSchedules\": {\n      \"MONTHLY\": {},\n      \"QUARTERLY\": {},\n      \"YEARLY\": {}\n    },\n    \"allowedEmailDomains\": [\n      \"<string>\"\n    ],\n    \"requireUniqueEmailDomain\": true,\n    \"requireUniqueEmailAddress\": true,\n    \"hideFuturePeriodsOverride\": true\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isPublic": true
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

isPublic

enum<boolean>

Available options:

true

name

string

description

string | null

Response

Successful response

string

required

name

string

required

description

string | null

required

isPublic

boolean

required

Get form List forms

Activity

ActivityDefinition

ApiKey

Benchmark

Cron Jobs

Dashboard

DatasetItem

Dataset

File

FormElement

FormElementSubmissionActivity

FormElementSubmissionComment

FormElementSubmission

FormSite

FormSubmission

Form

Import

Indicator

Organization

ReminderStatus

Site

Target

Unit

User

Widget

Update form

Authorizations

Path Parameters

Body

Response