Update an intake form's response

QA Environment

https://qa-api.kiolinkapp.com

PATCH

/v1/kiolink/intake-forms/{id}

Intake Forms

Last modified:2026-09-02 19:05:30

Maintainer:José María Esparza Arévalo

Required Permission(s):kiolink-event-update

Request

Authorization

API Key

Add parameter in header

authorization

Example:

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

Path Params

Body Params application/jsonRequired

Example

{
    "equipment_details": {
        "description": "string",
        "eccn": "string",
        "huawei_semiconductors_included": true
    },
    "advanced_ics_compliance": {
        "has_advanced_ics": "yes",
        "is_restricted_origin": "yes"
    },
    "export_license": {
        "is_required": "yes",
        "license_status": {
            "has_been_obtained": true,
            "application_submitted": true,
            "z_number": "string"
        }
    },
    "ownership": {
        "owns_all_equipment": true,
        "owner_details": {
            "name": "string",
            "headquarters": "string",
            "website": "string"
        }
    },
    "parties_involved": {
        "applicant": "string",
        "authorized_party": "string",
        "purchaser": "string",
        "principal_party_in_interest": "string",
        "intermediate_consignee": "string",
        "freight_forwarder": "string",
        "ultimate_consignee": "string",
        "ultimate_consignee_parent": "string",
        "end_user": "string",
        "end_user_parent": "string"
    },
    "compliance_check": {
        "has_violation_reason": true,
        "violation_explanation": "string"
    },
    "_device": "string",
    "_business": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://qa-api.kiolinkapp.com/v1/kiolink/intake-forms/6a7654b097b768b5ee34c47d' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "equipment_details": {
        "description": "string",
        "eccn": "string",
        "huawei_semiconductors_included": true
    },
    "advanced_ics_compliance": {
        "has_advanced_ics": "yes",
        "is_restricted_origin": "yes"
    },
    "export_license": {
        "is_required": "yes",
        "license_status": {
            "has_been_obtained": true,
            "application_submitted": true,
            "z_number": "string"
        }
    },
    "ownership": {
        "owns_all_equipment": true,
        "owner_details": {
            "name": "string",
            "headquarters": "string",
            "website": "string"
        }
    },
    "parties_involved": {
        "applicant": "string",
        "authorized_party": "string",
        "purchaser": "string",
        "principal_party_in_interest": "string",
        "intermediate_consignee": "string",
        "freight_forwarder": "string",
        "ultimate_consignee": "string",
        "ultimate_consignee_parent": "string",
        "end_user": "string",
        "end_user_parent": "string"
    },
    "compliance_check": {
        "has_violation_reason": true,
        "violation_explanation": "string"
    },
    "_device": "string",
    "_business": "string"
}'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "form_metadata": {
        "form_name": "KIO Customer Intake Form 3",
        "form_version": "3"
    },
    "equipment_details": {
        "description": "A more real equiment detail description.",
        "eccn": "I don't know what an ECCN looks like...",
        "huawei_semiconductors_included": true
    },
    "advanced_ics_compliance": {
        "has_advanced_ics": "no",
        "is_restricted_origin": "no"
    },
    "export_license": {
        "license_status": {
            "has_been_obtained": true,
            "application_submitted": true,
            "z_number": "115"
        },
        "is_required": "do_not_know"
    },
    "ownership": {
        "owner_details": {
            "name": "Monique Ferry",
            "headquarters": "Amazon HQ?",
            "website": "https://aws.com"
        },
        "owns_all_equipment": true
    },
    "parties_involved": {
        "applicant": "Jeff Bezos",
        "authorized_party": "Bezos",
        "purchaser": "Jeff",
        "principal_party_in_interest": "Bezos Jeff",
        "intermediate_consignee": "Jeff H. Bezos",
        "freight_forwarder": "JB",
        "ultimate_consignee": "JHB",
        "ultimate_consignee_parent": "Don Bezos",
        "end_user": "Father Martin",
        "end_user_parent": "Martin Luther King Jr. The Third"
    },
    "compliance_check": {
        "has_violation_reason": true,
        "violation_explanation": "Viva la France!"
    },
    "responsible": {
        "name": "Monique Ferry",
        "email": "monique.ferry@mail.com",
        "nationality": "European"
    },
    "visit_reason": "Upgrade",
    "_id": "6a7654b097b768b5ee34c47d",
    "_device": "69bc507a1a62b4599e553a95",
    "_user": {
        "_id": "69ab25325434ff2b1622fa6d",
        "firstname": "José María",
        "lastname": "Esparza Arévalo",
        "email": "jose.esparza@digitalignition.com.mx"
    },
    "_business": {
        "_id": "59ee474ee6d12c3085c6fdb0",
        "normalized_name": "amazon web services mexico",
        "name": "AMAZON WEB SERVICES MEXICO",
        "division_name": "DCS"
    },
    "created_at": "2026-08-07T21:57:04.980Z",
    "updated_at": "2026-08-07T22:06:06.809Z",
    "__v": 0
}

Modified at 2026-09-02 19:05:30

Upload an identification file to an intake form's response

Delete an intake form's response