Campañas y plantillas

Endpoints de campañas de email, campañas de llamadas y de las campañas masivas de SMS. Para el envío de un SMS suelto o la verificación por código de un solo uso (fuera de una campaña) ve a SMS y verificación.

Todos los endpoints de esta página cuelgan de /workspaces/:workspaceId/... y se autentican con tu API key.

Campañas de email

Cuelgan de /workspaces/:workspaceId/campaigns. Una campaña nace como DRAFT con solo el nombre y se completa por pasos (remitente, audiencia, asunto, diseño); preflight es la validación centralizada que decide si ya se puede programar.

Método	Ruta	Descripción
GET	/campaigns/tags	Listar etiquetas de campañas de email
POST	/campaigns/tags	Crear una etiqueta
PATCH	/campaigns/tags/:tagId	Editar una etiqueta
DELETE	/campaigns/tags/:tagId	Eliminar una etiqueta
POST	/campaigns	Crear campaña (borrador)
GET	/campaigns	Listar campañas
GET	/campaigns/:campaignId	Obtener una campaña
PATCH	/campaigns/:campaignId	Actualizar campaña
DELETE	/campaigns/:campaignId	Eliminar campaña
POST	/campaigns/:campaignId/duplicate	Duplicar campaña
POST	/campaigns/:campaignId/apply-template	Aplicar una plantilla de diseño
POST	/campaigns/:campaignId/test	Enviar correo de prueba
POST	/campaigns/:campaignId/approve	Aprobar campaña
POST	/campaigns/:campaignId/schedule	Programar envío
POST	/campaigns/:campaignId/unschedule	Quitar la programación
POST	/campaigns/:campaignId/pause	Pausar envío
POST	/campaigns/:campaignId/resume	Reanudar envío
POST	/campaigns/:campaignId/cancel	Cancelar campaña
GET	/campaigns/:campaignId/stats	Estadísticas de envío
GET	/campaigns/:campaignId/preflight	Checklist: qué falta para poder programar
GET	/campaigns/:campaignId/audience	Ver audiencia asignada (listas y contactos)
PUT	/campaigns/:campaignId/audience	Fijar audiencia (reemplaza la selección completa)
GET	/campaigns/:campaignId/audience/preview	Previsualizar la audiencia ya guardada
POST	/campaigns/:campaignId/audience/estimate	Estimar alcance de una selección aún sin guardar
GET	/campaigns/:campaignId/recipients	Listar destinatarios ya resueltos
GET	/campaigns/:campaignId/recipients/export	Exportar destinatarios (CSV)
DELETE	/campaigns/:campaignId/recipients/:recipientId	Quitar un destinatario
DELETE	/campaigns/:campaignId/recipients	Vaciar destinatarios

Consejo

Los destinatarios no se cargan por API: solo salen de la audiencia (listas y contactos del CRM) fijada con PUT /audience, que se congela en destinatarios al programar el envío.

POST /workspaces/:workspaceId/campaigns Copiar

Cuerpo de la petición

Campo	Tipo	Requerido	Descripción
name	string	Sí	Nombre de la campaña.
description	string	No	Descripción interna.
subject	string	No	Asunto del correo.
previewText	string	No	Texto de vista previa (máx. 200 caracteres).
fromName	string	No	Nombre del remitente.
fromEmail	string	No	Correo del remitente.
replyTo	string	No	Correo de respuesta.
tagIds	string[]	No	Etiquetas a asignar.
sendImmediately	boolean	No	Marca de envío inmediato para el paso de programación.
scheduledAt	string	No	Fecha preferida (se recalcula con hora/zona al programar).
timezone	string	No	Zona horaria IANA para scheduledAt.

Consejo

El diseño (htmlContent) no se manda aquí: se aplica con POST /:campaignId/apply-template. PATCH /:campaignId tampoco lo acepta — el HTML de un correo solo se escribe desde una plantilla.

cURL

curl -X POST "https://api.waiify.com/workspaces/WORKSPACE_ID/campaigns" \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Lanzamiento agosto", "subject": "Ya está disponible" }'

Node

await fetch('https://api.waiify.com/workspaces/WORKSPACE_ID/campaigns', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Lanzamiento agosto', subject: 'Ya está disponible' }),
});

Python

import requests

requests.post(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/campaigns",
    headers={"Authorization": "Bearer TU_API_KEY"},
    json={"name": "Lanzamiento agosto", "subject": "Ya está disponible"},
)

Respuesta 201

{
  "id": "camp_ab12cd34ef",
  "name": "Lanzamiento agosto",
  "subject": "Ya está disponible",
  "status": "DRAFT",
  "createdAt": "2026-06-17T10:00:00.000Z"
}

Dominios de envío

Cuelgan de /workspaces/:workspaceId/sender-domains. Verificar un dominio propio crea una identidad en la cuenta de AWS SES de la plataforma (registros DKIM por CNAME); mientras no verifica, los correos salen con el dominio de respaldo de Waiify.

Método	Ruta	Descripción
GET	/sender-domains	Listar dominios (paginado)
POST	/sender-domains	Agregar un dominio
POST	/sender-domains/:id/verify	Releer el estado de verificación en SES
POST	/sender-domains/:id/retry	Reiniciar verificación de un dominio en FAILED (rota los CNAME)
PUT	/sender-domains/:id/mail-from	Activar/quitar el prefijo MAIL FROM personalizado
DELETE	/sender-domains/:id	Eliminar un dominio

POST /workspaces/:workspaceId/sender-domains Copiar

Cuerpo de la petición

Campo	Tipo	Requerido	Descripción
domain	string	Sí	Dominio desde el que se quiere enviar (ej. midominio.com).

Consejo

La respuesta trae los registros DNS (CNAME) que hay que publicar en el proveedor del dominio. El estado pasa a verificado solo cuando SES los detecta — usa POST /:id/verify para releerlo sin esperar el próximo chequeo automático.

cURL

curl -X POST "https://api.waiify.com/workspaces/WORKSPACE_ID/sender-domains" \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "domain": "midominio.com" }'

Node

await fetch('https://api.waiify.com/workspaces/WORKSPACE_ID/sender-domains', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ domain: 'midominio.com' }),
});

Python

import requests

requests.post(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/sender-domains",
    headers={"Authorization": "Bearer TU_API_KEY"},
    json={"domain": "midominio.com"},
)

Respuesta 201

{
  "id": "dom_ab12cd34ef",
  "domain": "midominio.com",
  "status": "PENDING",
  "dkimRecords": [
    { "name": "abc123._domainkey.midominio.com", "type": "CNAME", "value": "abc123.dkim.amazonses.com" }
  ]
}

Remitentes

Cuelgan de /workspaces/:workspaceId/email-senders. Un remitente es una dirección nombre@dominio.com desde la que se puede enviar; se verifica con un código de 6 dígitos enviado a esa dirección (no requiere DNS, a diferencia de un dominio de envío).

Método	Ruta	Descripción
GET	/email-senders	Listar remitentes
POST	/email-senders	Crear remitente (envía el código de verificación)
POST	/email-senders/:senderId/verify	Confirmar remitente con el código recibido
POST	/email-senders/:senderId/resend	Reenviar el código de verificación
PATCH	/email-senders/:senderId	Editar el nombre del remitente
DELETE	/email-senders/:senderId	Eliminar remitente

Precaución

El correo del remitente no se puede editar una vez creado: es lo que quedó verificado. Para cambiarlo hay que crear un remitente nuevo.

POST /workspaces/:workspaceId/email-senders Copiar

Cuerpo de la petición

Campo	Tipo	Requerido	Descripción
name	string	Sí	Nombre visible en el «De» (máx. 60 caracteres).
email	string	Sí	Correo del remitente.

cURL

curl -X POST "https://api.waiify.com/workspaces/WORKSPACE_ID/email-senders" \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Ventas Waiify", "email": "ventas@midominio.com" }'

Node

await fetch('https://api.waiify.com/workspaces/WORKSPACE_ID/email-senders', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Ventas Waiify', email: 'ventas@midominio.com' }),
});

Python

import requests

requests.post(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/email-senders",
    headers={"Authorization": "Bearer TU_API_KEY"},
    json={"name": "Ventas Waiify", "email": "ventas@midominio.com"},
)

Respuesta 201

{
  "id": "sender_ab12cd34ef",
  "name": "Ventas Waiify",
  "email": "ventas@midominio.com",
  "status": "UNVERIFIED",
  "deliverability": "WAIIFY_FALLBACK",
  "senderDomain": null,
  "verifiedAt": null,
  "createdAt": "2026-06-17T10:00:00.000Z"
}

Supresiones

Cuelgan de /workspaces/:workspaceId/email-suppressions. Es la lista de correos a los que el workspace no puede volver a escribirle (se desuscribieron, rebotaron o marcaron como spam). Se alimenta sola con los eventos de SES; solo se puede leer y quitar entradas.

Método	Ruta	Descripción
GET	/email-suppressions	Listar la lista de supresión (paginado, con búsqueda)
DELETE	/email-suppressions/:id	Quitar un correo de la lista

Precaución

Quitar una entrada reactiva a alguien que pidió no recibir más correos, o que rebotó/nos marcó como spam. Tiene consecuencias reales sobre la reputación del dominio — úsalo solo cuando el contacto confirmó por otro medio que quiere volver a recibir campañas.

GET /workspaces/:workspaceId/email-suppressions Copiar

Parámetros de consulta

Parámetro	Tipo	Requerido	Descripción
page	number	No	Página (por defecto 1).
limit	number	No	Tamaño de página (por defecto 25, máximo 100).
search	string	No	Filtra por correo.

cURL

curl "https://api.waiify.com/workspaces/WORKSPACE_ID/email-suppressions?search=juan" \
  -H "Authorization: Bearer TU_API_KEY"

Node

const res = await fetch(
  'https://api.waiify.com/workspaces/WORKSPACE_ID/email-suppressions?search=juan',
  { headers: { Authorization: 'Bearer TU_API_KEY' } }
);

Python

import requests

requests.get(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/email-suppressions",
    headers={"Authorization": "Bearer TU_API_KEY"},
    params={"search": "juan"},
)

Respuesta 200

{
  "items": [
    { "id": "supp_ab12cd34ef", "email": "juan@example.com", "reason": "BOUNCE", "createdAt": "2026-06-01T10:00:00.000Z" }
  ],
  "total": 1,
  "page": 1,
  "limit": 25
}

Campañas de SMS

Cuelgan de /workspaces/:workspaceId/sms-campaigns. Son campañas masivas a listas/contactos del CRM — distinto del envío suelto y del OTP de SMS y verificación. Igual que en email, nace en DRAFT y se completa por pasos.

Método	Ruta	Descripción
GET	/sms-campaigns/providers	Proveedores de SMS disponibles
POST	/sms-campaigns/analyze-message	Contar segmentos/costo de un texto sin guardar nada
GET	/sms-campaigns/tags	Listar etiquetas de campañas de SMS
POST	/sms-campaigns/tags	Crear una etiqueta
PATCH	/sms-campaigns/tags/:tagId	Editar una etiqueta
DELETE	/sms-campaigns/tags/:tagId	Eliminar una etiqueta
POST	/sms-campaigns	Crear campaña (borrador)
GET	/sms-campaigns	Listar campañas
GET	/sms-campaigns/:campaignId	Obtener una campaña
PATCH	/sms-campaigns/:campaignId	Actualizar campaña
DELETE	/sms-campaigns/:campaignId	Eliminar campaña
POST	/sms-campaigns/:campaignId/duplicate	Duplicar campaña
GET	/sms-campaigns/:campaignId/preflight	Checklist: qué falta para poder programar
POST	/sms-campaigns/:campaignId/test	Enviar SMS de prueba
POST	/sms-campaigns/:campaignId/schedule	Programar o enviar de inmediato
POST	/sms-campaigns/:campaignId/unschedule	Quitar la programación
POST	/sms-campaigns/:campaignId/pause	Pausar envío
POST	/sms-campaigns/:campaignId/resume	Reanudar envío
POST	/sms-campaigns/:campaignId/cancel	Cancelar campaña
GET	/sms-campaigns/:campaignId/stats	Estadísticas de envío
POST	/sms-campaigns/:campaignId/retry-failed	Reintentar los envíos fallidos
GET	/sms-campaigns/:campaignId/audience	Ver audiencia asignada
PUT	/sms-campaigns/:campaignId/audience	Fijar audiencia (listas/contactos del CRM)
POST	/sms-campaigns/audience/estimate	Estimar alcance de una selección sin guardar
POST	/sms-campaigns/:campaignId/recipients/preview	Previsualizar un archivo de destinatarios (multipart)
POST	/sms-campaigns/:campaignId/recipients/import	Importar el archivo (multipart)
GET	/sms-campaigns/:campaignId/recipients	Listar destinatarios
GET	/sms-campaigns/:campaignId/recipients/export	Exportar destinatarios (CSV)
DELETE	/sms-campaigns/:campaignId/recipients/:recipientId	Quitar un destinatario
DELETE	/sms-campaigns/:campaignId/recipients	Vaciar destinatarios

Consejo

/sms-campaigns/audience/estimate no lleva :campaignId en la ruta: estima el alcance de una selección todavía sin asociar a ninguna campaña.

POST /workspaces/:workspaceId/sms-campaigns/:campaignId/schedule Copiar

Cuerpo de la petición

Campo	Tipo	Requerido	Descripción
sendImmediately	boolean	Uno de los dos	Enviar ya. Excluyente con scheduledAt.
scheduledAt	string	Uno de los dos	Fecha ISO de envío (debe ser futura).
timezone	string	No	Zona horaria IANA en la que el usuario eligió la fecha, solo para mostrarla después.

cURL

curl -X POST "https://api.waiify.com/workspaces/WORKSPACE_ID/sms-campaigns/CAMPAIGN_ID/schedule" \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scheduledAt": "2026-07-01T14:00:00.000Z", "timezone": "America/Bogota" }'

Node

await fetch(
  'https://api.waiify.com/workspaces/WORKSPACE_ID/sms-campaigns/CAMPAIGN_ID/schedule',
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer TU_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ scheduledAt: '2026-07-01T14:00:00.000Z', timezone: 'America/Bogota' }),
  }
);

Python

import requests

requests.post(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/sms-campaigns/CAMPAIGN_ID/schedule",
    headers={"Authorization": "Bearer TU_API_KEY"},
    json={"scheduledAt": "2026-07-01T14:00:00.000Z", "timezone": "America/Bogota"},
)

Respuesta 200

{
  "id": "smscamp_ab12cd34ef",
  "status": "SCHEDULED",
  "scheduledAt": "2026-07-01T14:00:00.000Z"
}

Campañas de llamadas

Cuelgan de /workspaces/:workspaceId/call-campaigns. La política de marcado (horarios, reglas de reintento, etapas) es un objeto grande y se documenta a fondo en la guía de campañas de llamadas y en Política — reglas; aquí solo se listan los endpoints.

Método	Ruta	Descripción
POST	/call-campaigns	Crear campaña
GET	/call-campaigns	Listar campañas
GET	/call-campaigns/:id	Obtener una campaña
PUT / PATCH	/call-campaigns/:id	Actualizar campaña
POST	/call-campaigns/:id/duplicate	Duplicar campaña
DELETE	/call-campaigns/:id	Eliminar campaña
PUT	/call-campaigns/:id/policy	Guardar la política de marcado completa
POST	/call-campaigns/:id/policy/validate	Validar una política sin guardarla
POST	/call-campaigns/:id/policy/preview	Previsualizar cómo se comportaría una política
POST	/call-campaigns/:id/contacts/import	Importar contactos (archivo)
POST	/call-campaigns/:id/contacts/import-from-crm	Importar contactos desde el CRM (por contactIds)
GET	/call-campaigns/:id/contacts	Listar contactos de la campaña
POST	/call-campaigns/:id/contacts/crm-status	Estado en la campaña de una página de contactos del CRM
GET	/call-campaigns/:id/contacts/:contactId/history	Historial de intentos de un contacto
GET	/call-campaigns/:id/preflight	Checklist: qué falta para poder activar
POST	/call-campaigns/:id/activate	Activar campaña
POST	/call-campaigns/:id/pause	Pausar campaña
POST	/call-campaigns/:id/resume	Reanudar campaña
POST	/call-campaigns/:id/stop	Detener campaña
GET	/call-campaigns/:id/metrics	Métricas agregadas
GET	/call-campaigns/:id/calls	Listar llamadas de la campaña
GET	/call-campaigns/:id/export	Exportar resultados (CSV)
POST	/call-campaigns/:campaignId/apply-template	Aplicar una plantilla de política
GET	/call-campaigns/:campaignId/export-policy	Exportar la política como JSON
POST	/call-campaigns/:campaignId/import-policy	Importar una política desde JSON

POST /workspaces/:workspaceId/call-campaigns Copiar

Cuerpo de la petición

Campo	Tipo	Requerido	Descripción
name	string	Sí	Nombre de la campaña (máx. 80 caracteres).
description	string	No	Descripción interna (máx. 1000 caracteres).
voiceAgentId	string	No	Asistente de voz que hará las llamadas.
verifiedCallerIdId	string	No	Número verificado desde el que se llama.
maxConcurrentCalls	number	No	Llamadas simultáneas (1–100, por defecto 5).
timezone	string	No	Zona horaria IANA (por defecto America/Bogota).
crmPipelineId	string	No	Pipeline del CRM a asociar.

Consejo

La campaña nace sin política de marcado. Guárdala con PUT /:id/policy (o aplícala desde una plantilla con POST /:campaignId/apply-template) — GET /:id/preflight bloquea activate mientras falte.

cURL

curl -X POST "https://api.waiify.com/workspaces/WORKSPACE_ID/call-campaigns" \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Recordatorio de pago",
    "voiceAgentId": "agent_ab12cd34ef",
    "maxConcurrentCalls": 10
  }'

Node

await fetch('https://api.waiify.com/workspaces/WORKSPACE_ID/call-campaigns', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Recordatorio de pago',
    voiceAgentId: 'agent_ab12cd34ef',
    maxConcurrentCalls: 10,
  }),
});

Python

import requests

requests.post(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/call-campaigns",
    headers={"Authorization": "Bearer TU_API_KEY"},
    json={
        "name": "Recordatorio de pago",
        "voiceAgentId": "agent_ab12cd34ef",
        "maxConcurrentCalls": 10,
    },
)

Respuesta 201

{
  "id": "callcamp_ab12cd34ef",
  "name": "Recordatorio de pago",
  "status": "DRAFT",
  "maxConcurrentCalls": 10,
  "timezone": "America/Bogota",
  "createdAt": "2026-06-17T10:00:00.000Z"
}

Plantillas de política de llamadas

Cuelgan de /workspaces/:workspaceId/campaign-templates. Una plantilla guarda una política de marcado reutilizable para aplicarla a varias campañas con POST /call-campaigns/:campaignId/apply-template. Ver también plantillas de campañas de llamadas.

Método	Ruta	Descripción
GET	/campaign-templates	Listar plantillas
GET	/campaign-templates/:id	Obtener una plantilla
POST	/campaign-templates	Crear plantilla
PUT	/campaign-templates/:id	Actualizar plantilla
DELETE	/campaign-templates/:id	Eliminar plantilla

POST /workspaces/:workspaceId/campaign-templates Copiar

Cuerpo de la petición

Campo	Tipo	Requerido	Descripción
name	string	Sí	Nombre de la plantilla (máx. 255 caracteres).
description	string	No	Descripción (máx. 1000 caracteres).
policy	object	Sí	Política de marcado completa — ver Política — reglas.

cURL

curl -X POST "https://api.waiify.com/workspaces/WORKSPACE_ID/campaign-templates" \
  -H "Authorization: Bearer TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Cobranza estándar",
    "policy": { "rounds": [{ "time": "09:00", "attempts": 3, "intervalMinutes": 30 }] }
  }'

Node

await fetch('https://api.waiify.com/workspaces/WORKSPACE_ID/campaign-templates', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer TU_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Cobranza estándar',
    policy: { rounds: [{ time: '09:00', attempts: 3, intervalMinutes: 30 }] },
  }),
});

Python

import requests

requests.post(
    "https://api.waiify.com/workspaces/WORKSPACE_ID/campaign-templates",
    headers={"Authorization": "Bearer TU_API_KEY"},
    json={
        "name": "Cobranza estándar",
        "policy": {"rounds": [{"time": "09:00", "attempts": 3, "intervalMinutes": 30}]},
    },
)

Respuesta 201

{
  "id": "tmpl_ab12cd34ef",
  "name": "Cobranza estándar",
  "policy": { "rounds": [{ "time": "09:00", "attempts": 3, "intervalMinutes": 30 }] },
  "createdAt": "2026-06-17T10:00:00.000Z"
}

Fuera de esta página

Plantillas de email (/workspaces/:workspaceId/templates) y plantillas de WhatsApp (/workspaces/:workspaceId/whatsapp-templates) no están aquí porque son endpoints internos: se montan solo con authMiddleware (sesión del dashboard), no con workspaceAuthMiddleware, así que una API key recibe 401. Lo mismo aplica a /campaign-notifications y /whatsapp-numbers.