Contele Fleet

create form template

POST

https://cgv-prd-checklist-api.contele.io/create-form-template

form-template

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

x-eov-operation-id:create_forms_templates_handler

x-eov-operation-handler:app

x-swagger-router-controller:app

x-codegen-request-body-name:body

create a new form template

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_templates

array[object (new_form_template) {8}]

requerido

string <uuid>

opcional

template_name

string

requerido

>= 1 Caracteres

template_status

string

opcional

template_public

boolean

opcional

settings_flags

array[string]

opcional

Exemplo:

["is_required_to_answer","auto_send_copy","show_only_when_visit_has_all_categories_and_at_least_one_user"]

segments

array[null (segments) {10}]

opcional

linked_urns

array[string]

opcional

external_observation

string | null

opcional

Exemplo

{
    "forms_templates": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "template_name": "string",
            "template_status": "string",
            "template_public": true,
            "settings_flags": [
                "is_required_to_answer",
                "auto_send_copy",
                "show_only_when_visit_has_all_categories_and_at_least_one_user"
            ],
            "segments": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "type": "section",
                    "title": "Título da seção"
                }
            ],
            "linked_urns": [
                "v0:product:context:context_id"
            ],
            "external_observation": "string"
        }
    ]
}

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/create-form-template' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "forms_templates": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "template_name": "string",
            "template_status": "string",
            "template_public": true,
            "settings_flags": [
                "is_required_to_answer",
                "auto_send_copy",
                "show_only_when_visit_has_all_categories_and_at_least_one_user"
            ],
            "segments": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "type": "section",
                    "title": "Título da seção"
                }
            ],
            "linked_urns": [
                "v0:product:context:context_id"
            ],
            "external_observation": "string"
        }
    ]
}'

Respostas

🟢201Criado

application/json

success

Body

forms_templates

array[object (new_form_template) {8}]

requerido

string <uuid>

opcional

template_name

string

requerido

>= 1 Caracteres

template_status

string

opcional

template_public

boolean

opcional

settings_flags

array[string]

opcional

Exemplo:

["is_required_to_answer","auto_send_copy","show_only_when_visit_has_all_categories_and_at_least_one_user"]

segments

array[null (segments) {10}]

opcional

linked_urns

array[string]

opcional

external_observation

string | null

opcional

Exemplo

{
    "forms_templates": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "template_name": "string",
            "template_status": "string",
            "template_public": true,
            "settings_flags": [
                "is_required_to_answer",
                "auto_send_copy",
                "show_only_when_visit_has_all_categories_and_at_least_one_user"
            ],
            "segments": [
                {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "type": "section",
                    "title": "Título da seção"
                }
            ],
            "linked_urns": [
                "v0:product:context:context_id"
            ],
            "external_observation": "string"
        }
    ]
}

🟠400Pedido inválido

🟠401Não autorizado

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