Tabla de contenidos
🌐 Post: dominio-de-oficina-virtual.com/api/leads
Header #
| Campo | Tipo | Descripción |
|---|---|---|
| authtoken | String | Token de autenticación, generado desde el área de administración. |
Estructura Json – PostLead – Header
Copy
{
"type": "object",
"properties": {
"authtoken": {
"type": "string"
}
}
}Parámetro:
| Campo | Tipo | Descripción |
|---|---|---|
| source | String | Obligatorio. Fuente del lead. |
| status | String | Obligatorio. Estado del lead. |
| name | String | Obligatorio. Nombre del lead. |
| assigned | String | Obligatorio. Usuario asignado al lead. |
| client_id | String | Opcional. ID del cliente del cual proviene el lead. |
| tags | String | Opcional. Etiquetas asociadas al lead. |
| contact | String | Opcional. Información de contacto del lead. |
| title | String | Opcional. Cargo o puesto del lead. |
| String | Opcional. Correo electrónico del lead. | |
| website | String | Opcional. Sitio web del lead. |
| phonenumber | String | Opcional. Número de teléfono del lead. |
| company | String | Opcional. Empresa asociada al lead. |
| address | String | Opcional. Dirección del lead. |
| city | String | Opcional. Ciudad del lead. |
| zip | String | Opcional. Código postal del lead. |
| state | String | Opcional. Estado o provincia del lead. |
| country | String | Opcional. País del lead. |
| default_language | String | Opcional. Idioma predeterminado del lead. |
| description | String | Opcional. Descripción o notas del lead. |
| custom_contact_date | String | Opcional. Fecha personalizada de contacto. |
| contacted_today | String | Opcional. Indica si el lead fue contactado hoy. |
| is_public | String | Opcional. ID de la hoja de Google asociada (si aplica). |
Datos de respuesta exitosa – Success 200 #
| Campo | Tipo | Descripción |
|---|---|---|
| status | Boolean | Estado de la solicitud. |
| message | String | Lead añadido correctamente. |
Ejemplo – Respuesta Exitosa – Success
Copy
HTTP/1.1 200 OK
{
"status": true,
"message": "Lead add successful."
}Error 4xx #
| Nombre | Tipo | Descripción |
|---|---|---|
| status | Boolean | Request status. |
| message | String | add fail. |
Ejemplo – Respuesta Fallida – Error
Copy
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Lead add fail."
}Estructura PostLead Exitoso – Success 200
Json – Sucess
Copy
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
}Estructura Error 4xx
Json – Error
Copy
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
}
