Entrar

Criar formulário

POST https://{organization}.myguper.com/api/register/datacapture/form

Define um template de formulário de captura de dados (ex.: opt-in/lead). Cada formulário é um name mais uma lista de fields. O formulário precisa incluir um campo cujo name corresponda ao identificador primário da organização (primeira coluna do matchPattern, normalmente cellphone ou email); esse campo é marcado automaticamente como required: true e identifier: true.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Corpo da requisição

Content-Type: application/json

{
    "name": "optin",
    "fields": [
        {
            "name": "name",
            "label": "Nome",                                    // optional
            "type": "text",                                     // optional
            "required": true,                                   // optional
            "metadata": false,                                  // optional
            "metaKey": "shirt_size"                             // optional
        }
    ]
}

Respostas

{
    "id": 1,
    "name": "optin",
    "fields": [
        { "name": "name",      "label": "Nome",     "type": "text",  "required": true },
        { "name": "email",     "label": "E-mail",   "type": "email", "required": true, "identifier": true },
        { "name": "cellphone", "label": "Telefone", "type": "text",  "required": false },
        { "name": "shirt_size", "label": "Tamanho", "type": "text",  "required": false, "metadata": true, "metaKey": "shirt_size" }
    ]
}
Copied to clipboard