Crea listas de exclusión
Crea listas de exclusión
Una lista de exclusión registra a las personas que pidieron no ser contactadas por un medio o para un uso: el registro No Molestar del SERNAC, una desuscripción de correos o una preferencia puntual, como no recibir campañas de un producto específico.
La plantilla de la lista (restriction template) define qué se bloquea. Crea tus plantillas con el endpoint POST /api/v1/restriction_templates.
Un consentimiento autoriza un tratamiento y una lista de exclusión lo prohíbe. Soyio guarda las dos cosas por separado, así que una misma persona puede tener un consentimiento y una restricción sobre el mismo dato.
Configuración de la plantilla
Define el nombre
Usa un nombre que identifique la lista dentro de tu equipo. Agrega una descripción si quieres dejar contexto, por ejemplo de dónde vienen las solicitudes.
{
"name": "SERNAC No Molestar",
"description": "Personas inscritas en el registro No Molestar del SERNAC"
}
La plantilla no se le muestra a la persona. A diferencia de una plantilla de consentimiento, no lleva título ni cláusula legal: solo declara qué se bloquea.
Define qué se bloquea
Declara en data_requirements las categorías de datos y los usos que la lista prohíbe, con la misma taxonomía que usan los consentimientos. La plantilla necesita al menos un requisito.
{
"data_requirements": [
{
"data_category": "user.contact.phone_number",
"data_uses": ["marketing.communications"]
}
]
}
Una restricción sobre un uso cubre todos sus usos hijos. Bloquear marketing.communications bloquea el correo, el SMS, las llamadas y WhatsApp, y también cualquier medio que se sume a la taxonomía más adelante.
Bloquear marketing.communications.email, .sms, .phone_call y .whatsapp por separado no equivale a bloquear marketing.communications. El uso padre incluye medios que no están enumerados, como una red social o un canal nuevo. Si quieres bloquear todos los medios, bloquea el padre.
Define el sujeto de datos
Indica en data_subject a quién aplica la lista. Usa uno de los sujetos de la taxonomía, por ejemplo customer.
{
"data_subject": "customer"
}
Define el alcance
Por defecto, una lista aplica a toda tu compañía. Para acotarla a uno o más productos o filiales, usa scopes con el mismo formato que las plantillas de consentimiento:
scope_type:"product"o"branch"scope_id: token público del producto o filialscope_version(opcional): si no lo envías, Soyio toma la última versión y la guarda en la plantilla
{
"scopes": [
{ "scope_type": "product", "scope_id": "prod_1B2M2Y8AsgTpgAmY7PhCfg" }
]
}
Los productos y filiales tienen que pertenecer a tu compañía, y cada alcance va una sola vez. Revisa la configuración de la empresa para crearlos.
Define la duración (opcional)
Por defecto, una restricción no vence: la persona sigue en la lista hasta que alguien la saca. Si la lista es para exclusiones por un tiempo acotado, indica en duration cuánto duran, en formato ISO 8601:
{
"duration": "P6M"
}
Para contar días hábiles en vez de corridos, agrega "duration_basis": "business_days" y expresa la duración en días enteros, por ejemplo "P10D".
El vencimiento de cada restricción se calcula al aplicarla, desde su effective_at, y queda fijo. Si después cambias la duración de la lista con PATCH /api/v1/restriction_templates/{id}, las restricciones que ya aplicaste conservan su vencimiento: editar la lista no las hace vencer. Si una acción de restricción trae su propio expires_at, ese prevalece sobre la duración de la lista.
Ten en cuenta que:
- Si aplicas la restricción con un
effective_atantiguo, el plazo se cuenta desde esa fecha. Una exclusión pedida hace más tiempo que la duración de la lista queda registrada, pero ya vencida. - Volver a aplicar la lista a alguien que ya está en ella extiende su vencimiento desde la nueva aplicación.
- Si la persona ya tenía una restricción sin vencimiento, volver a aplicarle una lista con duración no se lo agrega.
Deshabilita una lista
Envía enabled: false con PATCH /api/v1/restriction_templates/{id} para cerrar una lista:
{
"enabled": false
}
Una lista deshabilitada no acepta personas nuevas. Las restricciones que ya estaban aplicadas siguen vigentes, y las personas pueden salir de la lista igual.
Deshabilitar una plantilla de consentimiento no impide capturar consentimientos nuevos desde tus flujos. Deshabilitar una lista de exclusión sí impide agregar personas nuevas. Si integras los dos, no asumas que el campo se comporta igual.
Define si se puede levantar
Por defecto, las personas pueden salir de una lista. Si la lista no debe permitirlo, envía liftable: false:
{
"liftable": false
}
Soyio revisa liftable en la versión vigente de la plantilla al momento de levantar, no en la versión con la que se aplicó la restricción. Si cambias el valor, el cambio vale para todas las personas de la lista.
Ejemplos de listas
Registro No Molestar del SERNAC
{
"name": "SERNAC No Molestar",
"data_subject": "customer",
"data_requirements": [
{
"data_category": "user.contact.phone_number",
"data_uses": ["marketing.communications"]
}
]
}
Desuscripción de correos
{
"name": "Desuscripción de correos",
"data_subject": "customer",
"data_requirements": [
{
"data_category": "user.contact.email",
"data_uses": ["marketing.communications.email"]
}
]
}
Campañas de un producto específico
{
"name": "Sin campañas del programa de beneficios",
"data_subject": "customer",
"data_requirements": [
{
"data_category": "user.contact.phone_number",
"data_uses": ["marketing.communications"]
},
{
"data_category": "user.contact.email",
"data_uses": ["marketing.communications"]
}
],
"scopes": [
{ "scope_type": "product", "scope_id": "prod_1B2M2Y8AsgTpgAmY7PhCfg" }
]
}
Versionado de plantillas
Cada vez que modificas una plantilla, Soyio crea una versión nueva con el mismo ID. Las restricciones ya aplicadas conservan la versión con la que se aplicaron, así que editar la lista no cambia lo que ya estaba bloqueado.
Consulta el historial con GET /api/v1/restriction_templates/{id}/versions.
Permisos
Las listas de exclusión son un módulo propio: tu cuenta necesita tenerlo habilitado, aunque no uses el módulo de consentimiento. Por ahora se administran solo por API, y tu API key necesita alguno de estos permisos:
- Para consultar plantillas:
restriction_templates.api.readorestriction_templates.api.manage - Para crearlas y editarlas:
restriction_templates.api.writeorestriction_templates.api.manage
Los permisos generales del módulo (restrictions.api.read, restrictions.api.write y restrictions.api.manage) también dan acceso a estos endpoints.
Próximos pasos
- Aplica y consulta restricciones: agrega y saca personas de tus listas
- Taxonomía: revisa las categorías de datos y usos disponibles
- Referencia de la API: revisa el detalle de cada endpoint