Crear Segmentos

Última actualización:

Prisma Campaigns permite crear segmentos desde API de forma de facilitar la integración con sistemas externos, que pueden querer determinar que clientes pertenecen a cuales segmentos. Este es usualmente el caso al integrar con sistemas de datawarehouse o soluciones intensivas en uso de datos.

Crear desde una planilla

Este API crea un nuevo segmento a partir de una planilla, cargada en la propia invocación al API.

El mapeo de columnas no esta permitido en este API, por lo que todas las columnas definidas en la planilla cargada, deben existir en el modelo de clientes en Prisma, con exactamente el mismo nombre.

URL Método Formato
/api/segments/create-from-spreadsheet POST Multipart form data

El formato de los datos enviados es multipart/form-data y la lista de campos esperados es la siguiente.

Parámetro Descripción
app-token El token de la aplicación integrada realizando la invocación, con motivos de autenticación
segment-name Nombre del segmento a crear
file El archivo csv conteniendo los datos a cargar en este segmento particular

Los posibles códigos de retorno HTTP son:

Código Descripción Respuesta
200 La operación fue exitosa El identificador del segmento creado
400 Parámetro inválido Nombre del parámetro inválido
500 Falla creando el segmento Descripción del error

Cuándo la operación completa de forma exitosa, un objeto es retornado con un atributo de nombre segment-id

{“segment-id”:17592235066109}

Formato de Respuesta

Se debe especificar el header Accept con el formato deseado de respuesta, el valor por defecto es application/edn

Ejemplo

El API REST puede ser invocada desde cualquier lenguaje de programación con soporte para el protocolo HTTP.

Este es un ejemplo de invocación mediante el utilitario curl

curl -v -H “Accept: application/json” -F app-token=d63f4542-87e5-4570-8540-ef828afdfb40 -F segment-name=NewSegment -F file=@/Path/spreadsheet.csv https://domain/api/segments/create-from-spreadsheet

Artículos relacionados