Update an intake form

Updates the fields sent (nested objects are merged field by field). Every section sent must contain at least one field. The device, business, creator, visit reason and responsible person cannot be changed here.

Conditional rules still apply: sending application_submitted: true requires z_number in the same request, and owns_all_equipment: false requires owner_details.

Business users only see and change the forms of their own business; KIO users can access every form.

Requires a session token whose role has the kiolink-event-update permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Path Params

Body Params application/jsonRequired

Example

{
  "export_license": {
    "license_status": {
      "application_submitted": true,
      "z_number": "Z1234567"
    }
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200The updated form

application/json

The updated form.

Bodyapplication/json

Example

{
    "_id": "6a7654b097b768b5ee34c47d",
    "form_metadata": {
        "form_name": "KIO Customer Intake Form 4",
        "form_version": "4"
    },
    "equipment_details": {
        "description": "Servidor HPE ProLiant DL380 Gen10",
        "eccn": "5A992.c",
        "huawei_semiconductors_included": false
    },
    "advanced_ics_compliance": {
        "has_advanced_ics": "no",
        "is_restricted_origin": "no"
    },
    "export_license": {
        "is_required": "no",
        "license_status": {
            "has_been_obtained": false,
            "application_submitted": true,
            "z_number": "Z1234567"
        }
    },
    "ownership": {
        "owns_all_equipment": true
    },
    "parties_involved": {
        "applicant": "Digital Ignition"
    },
    "compliance_check": {
        "has_violation_reason": false
    },
    "responsible": {
        "name": "Ana López",
        "email": "ana.lopez@example.com",
        "nationality": "Mexicana"
    },
    "visit_reason": "Instalación de servidor nuevo",
    "_device": "65f1c2a9e4b0a1b2c3d4e5d1",
    "_business": {
        "_id": "65f1c2a9e4b0a1b2c3d4e5a1",
        "name": "Digital Ignition",
        "normalized_name": "digital ignition",
        "division_name": "Corporativo"
    },
    "_business_user": {
        "_id": "65f1c2a9e4b0a1b2c3d4e5f6",
        "firstname": "Ana",
        "lastname": "López",
        "email": "ana.lopez@example.com",
        "business": "65f1c2a9e4b0a1b2c3d4e5a1"
    },
    "created_at": "2026-10-06T16:00:00.000Z",
    "updated_at": "2026-10-06T16:00:00.000Z",
    "__v": 0
}

🟠400The request does not match the validation rules (Joi), or a

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🟠404The form does not exist (or belongs to another business)

🔴500Unexpected error