API v1 (1.0.0)ReferenceUsers

Update a student

POST/usuario/update/{usuario_email_id}

Updates the name, email, mobile phone and document of a student. A field that is missing or empty keeps its current value; other fields are ignored.

AuthorizationBearer <token>

The school API key, found in the dashboard settings, sent in the Authorization header. The Bearer prefix is optional.

In: header

Path Parameters

usuario_email_id*string

The student, by ID, email or document (CPF). A value that is a valid email is looked up by email; otherwise the digits are matched against the ID and the document.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/usuario/update/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "code": 200,  "success": true,  "data": {    "usuario": {      "cargo": "string",      "celular": "string",      "comecou_em": "2019-08-24T14:15:22Z",      "criado_em": "2019-08-24T14:15:22Z",      "doc": "string",      "email": "string",      "gratis": true,      "id": 0,      "login_auto": "http://example.com",      "login_crstk": "string",      "nome": "string",      "nome_empresa": "string",      "pontos": 0,      "tamanho_empresa": "string",      "ultimo_acesso_em": "2019-08-24T14:15:22Z",      "utm": {        "adcampaign": "string",        "adid": "string",        "fbclid": "string",        "gclid": "string",        "groupid": "string",        "page_name": "string",        "utm_content": "string",        "utm_medium": "string",        "utm_source": "string",        "utm_term": "string"      }    }  }}