MAmattilda-education
Usuarios

Actualizar Usuario

put/users/{userID}

Request

  • Base URL
    https://api.mattilda.school/matti_api/v1
  • URL
    https://api.mattilda.school/matti_api/v1/users/{userID}
  • Auth
    API key in header api_key

Path parameters

userIDstring uuid required

ID del Usuario que se desea trabajar.

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Request body

namestring

Nombre(s) de la persona, estudiante o usuario.

first_last_namestring

Apellido paterno de la persona, sea un estudiante o usuario.

second_last_namestring

Apellido materno de la persona, estudiante o usuario.

emailstring

Correo Electronico para el envio de facturas electronicas.

phonestring

Teléfono del usuario

addressstring

Dirección del usuario.

tinstring

Identificación del usuario fiscal.

document_type'CURP' | 'CI' | 'RUC' | 'NIT' | 'PASSPORT' | 'CC' | 'CE' | 'NIP' | 'TI' | 'PPT'

Tipo de documento según el país - México(CURP, PASSPORT), Colombia(PASSPORT, CC, CE, NIT, TI, NIP, PPT), Ecuador(PASSPORT, RUC, CI).

referred_idstring

Referido del usuario.

langstring

Idioma del usuario.

country_codestring

Código de país del usuario.

is_on_boardingboolean

Inicio en la plataforma usuario.

external_idstring

Campo arbitrario de datos de terceros

metadataobject

Campo arbitrario de datos de terceros

Example request

{
  "name": "Omar",
  "first_last_name": "Martinez",
  "second_last_name": "Jimenez",
  "email": "omar.martinez@mattilda.io",
  "tin": "PEGJ850315HJCRRN07",
  "document_type": "CURP",
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Response

Actualizar Usuario

idstring uuid

Identificador único del registro

created_atstring date-time

Fecha y hora de creacion del registro

updated_atstring date-time

Fecha y hora de creacion del registro

Example response

[
  {
    "id": "a12a51c4-3f69-464f-93eb-cc8d355f68b2",
    "created_at": "2023-09-01 14:44:17.600161",
    "updated_at": "2023-09-01 14:44:17.600161"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.