Entrar

Criar lista

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

Cria uma nova lista de audiência (linha em register.list) — segmento de clientes usado por campanhas, mensageria e endpoints de broadcast. Apenas name é obrigatório; o restante descreve como a lista é populada:

  • listType: manual — membros são adicionados um a um pelos endpoints audience-list/{id}/person.
  • listType: query — parameters carrega uma Audience Query (QON) que resolve dinamicamente.
  • listType: import — usado pelo fluxo de import por arquivo; consumidores devem usar o endpoint de upload dedicado em vez de montar esses campos aqui.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

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

Cabeçalhos

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.

Corpo da requisição

Content-Type: application/json

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

Respostas

{
    "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