Entrar

Crear formulario

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

Define una plantilla de formulario de captura de datos (ej.: opt-in/lead). Cada formulario es un name más una lista de fields. El formulario debe incluir un campo cuyo name coincida con el identificador primario de la organización (primera columna del matchPattern, generalmente cellphone o email); ese campo se marca automáticamente como required: true e identifier: true.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

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

Encabezados

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.

Cuerpo de la petición

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
        }
    ]
}

Respuestas

{
    "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