Entrar

Crear lista

POST https://{organization}.myguper.com/api/register/audience-list

Crea una nueva lista de audiencia (fila en register.list) — segmento de clientes usado por campañas, mensajería y endpoints de broadcast. Solo name es obligatorio; el resto describe cómo se llena la lista:

  • listType: manual — los miembros se agregan uno a uno mediante los endpoints audience-list/{id}/person.
  • listType: query — parameters contiene una Audience Query (QON) que se resuelve dinámicamente.
  • listType: import — usado por el flujo de importación por archivo; los consumidores deben usar el endpoint de carga dedicado en vez de armar estos campos aquí.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header.

Encabezados

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Cuerpo de la petición

Content-Type: application/json

{
    "name": "VIP customers — May campaign",
    "status": "new",                                            // optional
    "listType": "manual",                                       // optional
    "parameters": {},                                           // optional
    "contentHash": "<contentHash>"                              // optional
}

Respuestas

{
    "id": 42,
    "name": "VIP customers — May campaign",
    "status": "new",
    "listType": "manual",
    "parameters": null,
    "contentHash": null,
    "importStep": null,
    "importTotalRecords": null,
    "importStatsFound": null,
    "importStatsNotFound": null,
    "importStatsInvalid": null
}
Copied to clipboard