Entrar

Crear cliente

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

Crea un nuevo cliente (isCustomer = 1 en la tabla register.person). El campo name es obligatorio; al menos uno de cellphone, email o document también debe ser informado para que el registro pueda ser identificado después (ver matchPattern de la organización). El payload pasa por Person\Sanitize — el teléfono se normaliza vía libphonenumber, el correo se convierte a minúsculas y el documento conserva solo caracteres alfanuméricos en minúsculas.

En caso de éxito, devuelve el cliente recién creado ya con la etiqueta Rookie asignada y un registro de historial (Create person) insertado.

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": "Tintin",
    "entityType": "individual",                                 // optional
    "document": "32165987",                                     // optional
    "email": "tintim@guper.co",                                 // optional
    "countryCallingCode": 55,                                   // optional
    "cellphone": "19982456598",                                 // optional
    "dateOfBirth": "1989-03-29",                                // optional
    "postalCode": "13450000",                                   // optional
    "gender": "male",                                           // optional
    "language": "pt_BR",                                        // optional
    "optin": "2026-05-03T10:00:00-03:00",                       // optional
    "privacyAccepted": "2026-05-03T10:00:00-03:00"              // optional
}

Respuestas

{
    "id": 683752,
    "mainId": null,
    "entityType": "individual",
    "name": "Tintin",
    "email": "tintim@guper.co",
    "countryCallingCode": 55,
    "cellphone": "19982456598",
    "document": "32165987",
    "gender": "male",
    "postalCode": "13450000",
    "dateOfBirth": "1989-03-29",
    "language": "pt_BR",
    "createdAt": "2026-05-03T10:00:00-03:00",
    "updatedAt": "2026-05-03T10:00:00-03:00"
}
Copied to clipboard