> ## Documentation Index > Fetch the complete documentation index at: https://docs.azalt.co/llms.txt > Use this file to discover all available pages before exploring further. # 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 ## OpenAPI ````yaml https://app.azalt.co/api/v1/openapi.json put /forms/{id} openapi: 3.0.3 info: title: Erguvan Public API version: 1.0.0 servers: - url: https://app.azalt.co/api/v1 security: [] paths: /forms/{id}: put: tags: - Form summary: Update form description: >- 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 operationId: updateForm parameters: - in: path name: id schema: type: string required: true requestBody: required: true content: application/json: schema: type: object properties: isPublic: type: boolean enum: - true name: type: string description: type: string nullable: true tags: type: array items: type: string alternativeNames: type: array items: type: string showOrganizationLogo: type: boolean headerBgColor: type: string nullable: true logoWidth: type: number nullable: true headerPaddingTop: type: number nullable: true headerPaddingBottom: type: number nullable: true settings: type: object properties: allowPublicSubmissionEdits: type: boolean allowPublicSubmissionSupportingDocuments: type: boolean publicSupportingDocumentsMode: type: string enum: - all - opt-in workflowOverride: type: object nullable: true properties: type: type: string enum: - DIRECT_APPROVAL - REQUIRE_APPROVAL required: - type defaultSchedules: type: object properties: MONTHLY: type: object properties: dataEntry: type: object properties: dueDate: oneOf: - type: object properties: type: type: string enum: - fixed-day day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - day - type: object properties: type: type: string enum: - weekday-occurrence weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 occurrence: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 timing: type: string enum: - current-period - next-period required: - type - weekday - occurrence - type: object properties: type: type: string enum: - last-weekday weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 timing: type: string enum: - current-period - next-period required: - type - weekday - type: object properties: type: type: string enum: - specific-date month: type: integer minimum: 1 maximum: 12 day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - month - day reminders: type: object properties: enabled: type: boolean offsets: type: array items: type: object properties: type: type: string enum: - days-before days: type: integer minimum: 1 maximum: 30 required: - type - days required: - enabled - offsets required: - dueDate approval: type: object properties: dueDate: oneOf: - type: object properties: type: type: string enum: - fixed-day day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - day - type: object properties: type: type: string enum: - weekday-occurrence weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 occurrence: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 timing: type: string enum: - current-period - next-period required: - type - weekday - occurrence - type: object properties: type: type: string enum: - last-weekday weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 timing: type: string enum: - current-period - next-period required: - type - weekday - type: object properties: type: type: string enum: - specific-date month: type: integer minimum: 1 maximum: 12 day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - month - day reminders: type: object properties: enabled: type: boolean offsets: type: array items: type: object properties: type: type: string enum: - days-before days: type: integer minimum: 1 maximum: 30 required: - type - days required: - enabled - offsets required: - dueDate QUARTERLY: type: object properties: dataEntry: type: object properties: dueDate: oneOf: - type: object properties: type: type: string enum: - fixed-day day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - day - type: object properties: type: type: string enum: - weekday-occurrence weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 occurrence: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 timing: type: string enum: - current-period - next-period required: - type - weekday - occurrence - type: object properties: type: type: string enum: - last-weekday weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 timing: type: string enum: - current-period - next-period required: - type - weekday - type: object properties: type: type: string enum: - specific-date month: type: integer minimum: 1 maximum: 12 day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - month - day reminders: type: object properties: enabled: type: boolean offsets: type: array items: type: object properties: type: type: string enum: - days-before days: type: integer minimum: 1 maximum: 30 required: - type - days required: - enabled - offsets required: - dueDate approval: type: object properties: dueDate: oneOf: - type: object properties: type: type: string enum: - fixed-day day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - day - type: object properties: type: type: string enum: - weekday-occurrence weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 occurrence: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 timing: type: string enum: - current-period - next-period required: - type - weekday - occurrence - type: object properties: type: type: string enum: - last-weekday weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 timing: type: string enum: - current-period - next-period required: - type - weekday - type: object properties: type: type: string enum: - specific-date month: type: integer minimum: 1 maximum: 12 day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - month - day reminders: type: object properties: enabled: type: boolean offsets: type: array items: type: object properties: type: type: string enum: - days-before days: type: integer minimum: 1 maximum: 30 required: - type - days required: - enabled - offsets required: - dueDate YEARLY: type: object properties: dataEntry: type: object properties: dueDate: oneOf: - type: object properties: type: type: string enum: - fixed-day day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - day - type: object properties: type: type: string enum: - weekday-occurrence weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 occurrence: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 timing: type: string enum: - current-period - next-period required: - type - weekday - occurrence - type: object properties: type: type: string enum: - last-weekday weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 timing: type: string enum: - current-period - next-period required: - type - weekday - type: object properties: type: type: string enum: - specific-date month: type: integer minimum: 1 maximum: 12 day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - month - day reminders: type: object properties: enabled: type: boolean offsets: type: array items: type: object properties: type: type: string enum: - days-before days: type: integer minimum: 1 maximum: 30 required: - type - days required: - enabled - offsets required: - dueDate approval: type: object properties: dueDate: oneOf: - type: object properties: type: type: string enum: - fixed-day day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - day - type: object properties: type: type: string enum: - weekday-occurrence weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 occurrence: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 timing: type: string enum: - current-period - next-period required: - type - weekday - occurrence - type: object properties: type: type: string enum: - last-weekday weekday: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 timing: type: string enum: - current-period - next-period required: - type - weekday - type: object properties: type: type: string enum: - specific-date month: type: integer minimum: 1 maximum: 12 day: type: integer minimum: 1 maximum: 31 timing: type: string enum: - current-period - next-period required: - type - month - day reminders: type: object properties: enabled: type: boolean offsets: type: array items: type: object properties: type: type: string enum: - days-before days: type: integer minimum: 1 maximum: 30 required: - type - days required: - enabled - offsets required: - dueDate scoring: type: object properties: enabled: type: boolean showScoreToSubmitter: type: boolean showActionTextToSubmitter: type: boolean default: false basis: type: string enum: - score - percentage tiers: type: array items: type: object properties: id: type: string name: type: string minLength: 1 minScore: type: number maxScore: type: number color: type: string description: type: string nullable: true required: - id - name - minScore - maxScore required: - enabled - showScoreToSubmitter - tiers allowedEmailDomains: type: array items: type: string requireUniqueEmailDomain: type: boolean requireUniqueEmailAddress: type: boolean hideFuturePeriodsOverride: type: boolean nullable: true metadata: type: object additionalProperties: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string name: type: string description: type: string nullable: true isPublic: type: boolean required: - id - name - description - isPublic '400': description: Invalid input data content: application/json: schema: $ref: '#/components/schemas/error.BAD_REQUEST' '401': description: Authorization not provided content: application/json: schema: $ref: '#/components/schemas/error.UNAUTHORIZED' '403': description: Insufficient access content: application/json: schema: $ref: '#/components/schemas/error.FORBIDDEN' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/error.NOT_FOUND' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR' security: - Authorization: [] components: schemas: error.BAD_REQUEST: type: object properties: message: type: string description: The error message example: Invalid input data code: type: string description: The error code example: BAD_REQUEST issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Invalid input data error (400) description: The error information example: code: BAD_REQUEST message: Invalid input data issues: [] error.UNAUTHORIZED: type: object properties: message: type: string description: The error message example: Authorization not provided code: type: string description: The error code example: UNAUTHORIZED issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Authorization not provided error (401) description: The error information example: code: UNAUTHORIZED message: Authorization not provided issues: [] error.FORBIDDEN: type: object properties: message: type: string description: The error message example: Insufficient access code: type: string description: The error code example: FORBIDDEN issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Insufficient access error (403) description: The error information example: code: FORBIDDEN message: Insufficient access issues: [] error.NOT_FOUND: type: object properties: message: type: string description: The error message example: Not found code: type: string description: The error code example: NOT_FOUND issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Not found error (404) description: The error information example: code: NOT_FOUND message: Not found issues: [] error.INTERNAL_SERVER_ERROR: type: object properties: message: type: string description: The error message example: Internal server error code: type: string description: The error code example: INTERNAL_SERVER_ERROR issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Internal server error error (500) description: The error information example: code: INTERNAL_SERVER_ERROR message: Internal server error issues: [] securitySchemes: Authorization: type: http scheme: bearer ````