Create a new list

Creates a new subscriber list in the authenticated account.

List Types

  • EMAIL (default): Standard subscriber list. Each email address must be unique — a subscriber can only appear once.
  • CRM: CRM-type list. Each email address must be unique — a subscriber can only appear once.
  • ORDER: Order/e-commerce list. The same email address can appear multiple times, as each row represents a separate order.

Project Folder

Use projectFolderId to place the list inside a project folder:

  • Pass 0 to place the list in the root (default) folder.
  • Pass a valid project folder ID to place the list in a specific folder. The folder must belong to the authenticated account.

Copying integration settings

A newly created ORDER list has no integration settings. Pass copyIntegrationsFromListId (ORDER type only) to copy the
integration settings of an existing order list of the same account onto the new list:
billing (szamlazz.hu, Billingo v3, Cashman, Innvoice, ...), payment gateways (SimplePay, PayPal, OTP, Wirecard, Braintree, Stripe, Barion, Borgun, Sagepay),
logistics (Webshippy, Packeta, Boxy), eSzerződés, HibridLevel and PostaPont.
References to objects of the source list, such as update forms, IPN forms or retry landing pages, are not carried over.
Billingo v2 connections, Cegjelző, Shoprenter, ElevenLabs and OpenAI are not copied.
The list is created even if an individual integration cannot be copied — the response reports the outcome in
copiedIntegrations and failedIntegrationCopies.

Default Behavior

  • List type defaults to EMAIL if not specified.
  • Language defaults to hu (Hungarian) if not specified.
  • Currency defaults to HUF if not specified.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

The name of the list

integer
required
≥ 0

The ID of the project folder in which to create the list.
Use 0 to place the list in the root (default) folder.
The folder must belong to the authenticated account.

string
enum
Defaults to EMAIL

The type of the list. Determines email address uniqueness behavior:

  • EMAIL (default): Each email address must be unique per subscriber.
  • CRM: Each email address must be unique per subscriber.
  • ORDER: The same email address can appear multiple times (one row per order).
Allowed:
string

An optional description for the list

string
enum
Defaults to hu

The language code for the list. Affects system field labels and notification messages.

Allowed:
string
enum
Defaults to HUF

The currency code used for ORDER type lists (e.g. HUF, EUR). Ignored for EMAIL and CRM types.

integer
≥ 1

Only valid together with type: ORDER. The ID of an existing ORDER list of the authenticated account whose
integration settings (billing, payment gateways, logistics, ...) are copied onto the new list.
Update forms, IPN forms and landing pages the source integrations refer to are not carried over.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json