Skip to main content
POST
La respuesta confirma la creación del lote con su batchId, status: "created" y source. Esta operación no devuelve operationId ni el header Location. Usa source: "api" para crear un lote vacío, sin subir un CSV. Debes incluir duplicateStrategy para definir cómo tratar los contactos repetidos; no admite null ni puede omitirse. También puedes incluir rules para configurar las reglas de marcación desde el inicio.
Después de crear un lote con source: "api", añade los contactos mediante POST /batches/{batchId}/contacts. Esa carga sí devuelve un operationId para consultar su progreso.

Authorizations

apikey
string
header
required

API key obtenida desde la interfaz de Inagent, dentro del marcador.

Body

application/json
name
string
required

Nombre del lote. Tiene que ser único en la cuenta: repetirlo responde 400.

Maximum string length: 100
Example:

"Cobranzas agosto"

channelId
string<uuid>
required

Canal a través del cual se realizarán las llamadas.

tempCsvKey
string
required

Clave del CSV ya subido, tal como la devuelve POST /batches/upload-url en su campo tempCsvKey.

Se consume al crear el lote: no sirve para un segundo alta.

Example:

"csv-uploads/acme/3f8a1b2c-5d6e-4f70-8a9b-1c2d3e4f5a6b-contactos-agosto.csv"

mapping
object
required

Qué columna del CSV es cada cosa.

Los nombres son los del encabezado del archivo, tal como figuran.

duplicateStrategy
object
required

Política ante contactos repetidos. Es obligatoria y no admite null: la detección de duplicados no puede desactivarse omitiendo este campo.

channelPriority
integer
default:1

Peso del lote al repartir la capacidad del canal entre lotes que corren a la vez. Más alto recibe más capacidad.

Required range: 1 <= x <= 10
source
enum<string>

Indica que el lote se crea vacío y que sus contactos se cargarán mediante la API. Omítalo cuando el lote se cree desde un CSV.

Available options:
api
expectedRowCount
integer

Número de filas previsto en el archivo. Se utiliza únicamente para estimar el progreso de la importación antes de terminar de contarlo; no valida nada.

filters
object

Filtra qué filas del CSV se importan. Sin filtros se importa el archivo completo.

rules
object

Reglas de marcación propias del lote (intentos, esperas, ventana horaria). Omitido, el lote hereda las reglas de la cuenta para su tipo de canal.

Response

Lote creado. Si se indicó un CSV, su importación ocurre en segundo plano y puede seguirse consultando el lote mediante su batchId.

batchId
string<uuid>
required
status
enum<string>
required
Available options:
created
source
string
required

Origen del lote.

Example:

"api"