Entrar

Criar cliente

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

Cria um novo cliente (isCustomer = 1 na tabela register.person). O campo name é obrigatório; pelo menos um entre cellphone, email ou document também deve ser informado para que o registro possa ser pareado depois (ver matchPattern da organização). O payload passa por Person\Sanitize — telefone é normalizado via libphonenumber, e-mail é convertido para minúsculas, e o documento mantém apenas caracteres alfanuméricos em minúsculas.

Em caso de sucesso, retorna o cliente recém-criado já com a tag Rookie atribuída e um registro de histórico (Create person) inserido.

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": "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
}

Respostas

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