Code groups
A code group is a batch: a set of containers created ahead of time, before anyone knows who will end up using each one. It is the mechanism behind journeys built on a pre-printed physical support — a card or a box printed before a single recipient is known.
What a code group is
A code group does not describe a journey by itself — it is a label that ties a set of containers together, so a batch created today can be queried, filtered, and reasoned about as one unit tomorrow, regardless of when each container is later put to use.
Setting a code group at creation
codeGroup is an optional field on the container creation body. Set it when a container is created as part of a batch rather than on demand for a single, already-known recipient.
{
"crid": "…",
"codeGroup": "…"
}Listing code groups
GET /code-groups lists the code groups known to your account. It requires the code_groups:read scope.
curl https://client-api.v5.livstick.com/api/v3/code-groups \
-H "Authorization: Bearer {ACCESS_TOKEN}"Filtering messages by code group
GET /messages can be filtered by code group as well as by crid, so you can pull every message that belongs to a batch without listing its containers one by one first.
What this page does not cover
This page describes the code group mechanism itself, not a specific product journey built on it. The detail of Activate’s pre-printed-support journeys is not yet settled, so it is intentionally left out rather than guessed at.