Algebraix logo
Powered by Redocly

General

Agregar prospecto

Request
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Request Body schema: application/json
required
name
required
string [ 1 .. 64 ] characters

Nombre

lastname1
required
string [ 1 .. 64 ] characters

Primer apellido

lastname2
string

Segundo apellido

gender
required
string

Género (m/f)

Enum: "m" "f"
curriculum_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador del currículum

section_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador de la sección

level_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador del grado

cicle_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador del ciclo

process_id
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador del proceso de admisión

enrollment_prospect
boolean

Indica si el prospecto viene de inscripción online

birthday
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha de nacimiento

email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...

Correo electrónico

telephone
string

Número de teléfono

mobile_telephone
string

Número de teléfono móvil

object

Primer contacto adicional (opcional)

object

Segundo contacto adicional (opcional)

extra_data
object

Campos adicionales

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/prospects
Request samples
application/json
{
  • "name": "Juan",
  • "lastname1": "Pérez",
  • "lastname2": "López",
  • "gender": "m",
  • "curriculum_id": "OOMWQDUB",
  • "section_id": "OOMWQDUB",
  • "level_id": "OOMWQDUB",
  • "cicle_id": "OOMWQDUB",
  • "process_id": "OOMWQDUB",
  • "enrollment_prospect": false,
  • "birthday": "01/01/2000",
  • "email": "juan.perez@example.com",
  • "telephone": "6621234567",
  • "mobile_telephone": "6629876543",
  • "contact1": {
    },
  • "contact2": {
    }
}
Response samples
application/json
{
  • "details": [ ],
  • "id": "WADFERF3",
  • "message": "Prospect created"
}
➔ Next to General