Un sistema externo ve el listado de listas de distribución de correo y suscribe a un contacto a una o varias. Al suscribir se deja su autorización para recibir correos, por eso nace apagada y suscribir es un permiso explícito.
Permisos#
| Permiso | Para qué sirve | Tipo |
|---|---|---|
listas:leer | Ver las listas de distribución | lectura |
listas:suscribir | Suscribir contactos a listas de distribución | escritura |
Endpoints#
GET /listas#
Lista las listas de distribución de correo activas: id, nombre, descripción y cuántos contactos tienen. Con «q» filtra por nombre; paginado.
Permiso: listas:leer · lectura
Parámetros de la consulta#
| Parámetro | Descripción |
|---|---|
q | texto que debe contener el nombre de la lista |
pagina | número de página (1 por defecto) |
limite | resultados por página, de 1 a 100 (25 por defecto) |
curl "https://TU_SUBDOMINIO.connecto.lat/api/v1/listas?q=valor" \
-H "Authorization: Bearer cnx_TU_LLAVE"const respuesta = await fetch("https://TU_SUBDOMINIO.connecto.lat/api/v1/listas?q=valor", {
method: "GET",
headers: { "Authorization": "Bearer " + process.env.CONNECTO_API_KEY }
});
const datos = await respuesta.json();$ch = curl_init("https://TU_SUBDOMINIO.connecto.lat/api/v1/listas?q=valor");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("CONNECTO_API_KEY")],
]);
$datos = json_decode(curl_exec($ch), true);POST /listas/suscribir#
Suscribe un contacto a una o varias listas de distribución y deja su autorización para recibir correos como «otorgada» (quien integra responde de haberla obtenido). El contacto se busca por su correo (o contacto_id). Una baja no se revierte sola: si el contacto se dio de baja de los correos, no se suscribe (responde baja_previa) salvo que se envíe «reactivar_baja»: true porque la persona volvió a pedirlo.
Permiso: listas:suscribir · escritura
Cuerpo (JSON)#
| Campo | Descripción |
|---|---|
email | el correo del contacto (obligatorio si no envías contacto_id) |
listas | obligatorio: lista de ids de las listas (GET /listas), hasta 50 |
contacto_id | opcional: id del contacto; el correo debe ser uno de los suyos |
crear_contacto | opcional: true para crear el contacto si no existe uno con ese correo |
nombre | opcional: nombre para el contacto nuevo |
reactivar_baja | opcional: true solo si la persona se dio de baja y volvió a pedir suscribirse |
{
"email": "[email protected]",
"listas": [
1172,
917
],
"crear_contacto": true,
"nombre": "Ana Pérez"
}curl -X POST "https://TU_SUBDOMINIO.connecto.lat/api/v1/listas/suscribir" \
-H "Authorization: Bearer cnx_TU_LLAVE" \
-H "Content-Type: application/json" \
-d '{"email":"[email protected]","listas":[1172,917],"crear_contacto":true,"nombre":"Ana Pérez"}'const respuesta = await fetch("https://TU_SUBDOMINIO.connecto.lat/api/v1/listas/suscribir", {
method: "POST",
headers: { "Authorization": "Bearer " + process.env.CONNECTO_API_KEY, "Content-Type": "application/json" },
body: JSON.stringify({
"email": "[email protected]",
"listas": [
1172,
917
],
"crear_contacto": true,
"nombre": "Ana Pérez"
})
});
const datos = await respuesta.json();$ch = curl_init("https://TU_SUBDOMINIO.connecto.lat/api/v1/listas/suscribir");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("CONNECTO_API_KEY"), "Content-Type: application/json"],
CURLOPT_POSTFIELDS => json_encode(array (
'email' => '[email protected]',
'listas' =>
array (
0 => 1172,
1 => 917,
),
'crear_contacto' => true,
'nombre' => 'Ana Pérez',
)),
]);
$datos = json_decode(curl_exec($ch), true);Respuesta#
listar: {"datos": [{"id", "nombre", "descripcion", "contactos", "creada_at"}], "total", "pagina", "limite", "hay_mas"}. suscribir: {"datos": {"contacto_id", "contacto_creado", "se_dio_de_baja", "autorizacion_correo", "listas": [{"lista_id", "nombre", "estado": "suscrito" | "ya_estaba" | "baja_previa" | "no_existe"}]}}. Errores: 404 contacto_no_encontrado, 422 dato_invalido / correo_no_pertenece / contacto_sin_correo, 503 api_deshabilitada.