Sign in

Create audience list

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

Creates a new audience list (register.list row) — the segment of customers used by campaigns, messaging, and broadcast endpoints. Only name is required; everything else describes how the list is populated:

  • listType: manual — members are added one-by-one via the audience-list/{id}/person endpoints.
  • listType: query — parameters holds an Audience Query (QON) that resolves dynamically.
  • listType: import — used by the file-import flow; consumers should set the import fields via the dedicated upload endpoint instead of crafting them here.

Try-it values populated from environment ACME (Demo)


Authentication

Token

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

Headers

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.

Request body

Content-Type: application/json

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

Responses

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