Contele Fleet

update form status

POST

https://cgv-prd-checklist-api.contele.io/update-forms-status

forms

Última modificação:2025-05-26 16:37:01

x-eov-operation-id:update_forms_status_handler

x-eov-operation-handler:app

x-swagger-router-controller:app

x-codegen-request-body-name:body

change form status to archived or active

Requisição

Parâmetros Header

x-api-key

string

requerido

Esta chave é obtida através do sistema por meio do gerenciamento da OpenAPI

Padrão:

Parâmetros Bodyapplication/json

forms_ids

array[string <uuid>]

requerido

status

enum<string>

requerido

Valores permitidos:

activeinactive

Exemplo

{
    "forms_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "status": "active"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://cgv-prd-checklist-api.contele.io/update-forms-status' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "forms_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "status": "active"
}'

Respostas

🟢200OK

application/json

success

Body

forms

array[object (new_form) {5}]

requerido

string <uuid>

opcional

form_template_id

string <uuid>

requerido

answers

array[object (new_answer_list) {3}]

opcional

linked_urns

array[string]

opcional

time_to_complete_checklist_in_seconds

integer | null

opcional

Exemplo

{
    "forms": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "form_template_id": "5c7e6466-5d17-4998-88d1-06bf3e99d001",
            "answers": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "form_question_id": "ee348bf7-db46-4080-b396-2f4d8998e46c",
                    "answer": "string"
                }
            ],
            "linked_urns": [
                "v0:product:context:context_id"
            ],
            "time_to_complete_checklist_in_seconds": 0
        }
    ]
}

🟠401Não autorizado

Modificado em 2025-05-26 16:37:01