Algebraix logo
Powered by Redocly

General

Obtener prospectos

Obtener lista de prospectos del CRM

Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Límite de prospectos

page
integer >= 1
Default: 1

Número de página de consulta

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

Filtrar prospectos por identificador del proceso de admisión

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.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/prospects
Request samples 
Response samples 
application/json
[
  • {
    }
]
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": {
    },
  • "extra_data": {
    }
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "WADFERF3",
  • "message": "Prospect created"
}
Obtener prospecto por ID
Obtener información detallada de un prospecto específico


Request 
path Parameters
prospect_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del prospecto


 
 Example:  UD5WVDPH
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.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/prospects/{prospect_id}
Request samples 
Response samples 
application/json
{
  • "id": "stringst",
  • "name": "string",
  • "lastname1": "string",
  • "lastname2": "string",
  • "lastname": "string",
  • "fullname": "string",
  • "sex": "string",
  • "email": "string",
  • "telephone": "string",
  • "mobile_telephone": "string",
  • "birthday": "string",
  • "kanban_stage_id": "stringst",
  • "current_stage_name": "string",
  • "current_stage_color": "string",
  • "creator_user": "string",
  • "creator_type": "string",
  • "create_date_time": "string",
  • "is_internet_applicant": true,
  • "process": {
    },
  • "curriculum": {
    },
  • "section": {
    },
  • "level": {
    },
  • "cicle": {
    },
  • "contacts": [
    ]
}
Actualizar prospecto por ID
Actualización parcial de un prospecto específico


Request 
path Parameters
prospect_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del prospecto


 
 Example:  UD5WVDPH
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
name
string
Nombre


 
lastname1
string
Primer apellido


 
lastname2
string
Segundo apellido


 
sex
string
Género (m/f)


 Enum: "m" "f"  
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


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


 
curriculum_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador del currículum


 
section_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador de la sección


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


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


 
id (string) or null
Identificador del proceso de admisión (enviar null para remover del proceso)


 
extra_data
object
Campos adicionales (se fusionan con los existentes)


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/prospects/{prospect_id}
Request samples 
application/json
{
  • "name": "Juan",
  • "email": "juan.perez@example.com",
  • "telephone": "6621234567",
  • "process_id": "OOMWQDUB",
  • "extra_data": {
    }
}
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Prospect updated"
}
➔ Next to General