Campañas y contactos en la API

Una campaña se compone de tres partes: contactos, grupo de opciones del primer mensaje y cuentas vinculadas. A continuación, las operaciones de la versión v2; el identificador del cliente se sustituye por el token.

Campañas#

GET/v2/campaigns

Lista de campañas del cliente.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

POST/v2/campaigns

Crear una campaña. El cuerpo de la solicitud es JSON.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

GET/v2/campaigns/{campaign_id}

Tarjeta de campaña.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

POST/v2/campaigns/{campaign_id}/update

Modificar los parámetros de la campaña. El cuerpo de la solicitud es JSON.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

ELIMINAR/v2/campaigns/{campaign_id}

Eliminar la campaña junto con sus contactos y el grupo de mensajes.

Autorización

Autorizacióncadena

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idcadenarequerido

UUID de la campaña

Cuentas de campaña#

POST/v2/campaigns/{campaign_id}/accounts

Vincular cuentas a la campaña: de ellas se enviarán salidas. El cuerpo de la solicitud es JSON.

Autorización

Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

DELETE/v2/campaigns/{campaign_id}/accounts

Desvincular cuentas de la campaña. El cuerpo de la solicitud es JSON.

Autorización

Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

Contactos#

Los contactos de la campaña se cargan mediante un archivo y se exportan en el mismo formato. El parámetro format solo acepta csv o xlsx, por defecto csv.

POST/v2/campaigns/{campaign_id}/contacts/upload

Cargar la base de contactos mediante un archivo. El cuerpo de la solicitud es multipart/form-data con el campo file.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

Cuerpo

formatostring

csv o xlsx, por defecto csv

GET/v2/campaigns/{campaign_id}/contacts

Lista de contactos de la campaña.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

GET/v2/campaigns/{campaign_id}/contacts/stats

Resumen de los contactos de la campaña.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

GET/v2/campaigns/{campaign_id}/contacts/export

Exportar contactos de la campaña en un archivo.

Autorización

Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

Consulta

formatostring

csv o xlsx, por defecto csv

DELETE/v2/campaigns/{campaign_id}/contacts

Limpiar la base de contactos de la campaña.

Autorización

Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

Pool de mensajes#

El pool almacena las variantes del mensaje inicial. El NN Agent toma de él el texto para el siguiente contacto, por lo que el mismo texto no se envía a toda la base de forma consecutiva.

GET/v2/campaigns/{campaign_id}/message-pool

Lista de variantes del primer mensaje de la campaña.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

POST/v2/campaigns/{campaign_id}/message-pool

Agregar una variante de mensaje al pool. El cuerpo de la solicitud es JSON.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

DELETE/v2/campaigns/{campaign_id}/message-pool/{message_id}

Eliminar una variante del pool.

Autorización

Autorizaciónstring

Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta

campaign_idstringrequerido

UUID de la campaña

message_idstringrequerido

UUID de la variante del mensaje

Siguiente#

Iniciar la primera campaña por API — orden de llamadas completo.
Diálogos — qué sucede después de enviar el primer mensaje.
AI Outreach — la misma mecánica en el panel.

Updated Aug 26, 2026