List

Manage code lists. Create, retrieve, update, and delete lists used to group and distribute codes.

A list is created underneath an account (/accounts/{accountUuid}/lists) and carries the rules that govern how its codes are published: codesUnique (yes/no) controls whether the same code can be handed out to more than one receiver, publicationOrder (sequential or random) controls the order codes are drawn in, and canPublishFrom/canPublishUntil define the validity window during which codes can be published. An optional maxPublications caps the total number of codes that can be published from the list.

Each list also has a status of active, inactive, deleted, or draft, and its collection response reports running totals such as totalCodesActive, totalCodesPublished, and totalPublications, so you can track consumption of a list without having to enumerate its individual codes.