Archive a tier
Archive a tier. Archiving is one-way: the tier stops all new assignment and evaluation, while existing participant tier state is preserved as historical.
key path parameter identifies which tier to archive, scoped to the program in programId. A program route only archives a program-scoped tier; it will not archive an organization-level tier that a program inherits.
Archiving is one-way. An archived tier has status set to ARCHIVED and archived_at set to the time of the call, and it cannot be returned to ACTIVE.
An archived tier stops all new assignment and evaluation:
SET_TIERrule actions targeting the tier are skipped. The event still completes.- Automatic qualification and period-end re-evaluation no longer assign the tier.
- Manual assignment (
PUT) and tier updates (PATCH) are rejected with409 Conflictand codetier_archived.
GET requests.
A tier cannot be archived while any ACTIVE or SUSPENDED rule still references its key (in a SET_TIER action or a CEL condition). The request is rejected with 409 Conflict and code tier_referenced_by_rules, and the error details list the referencing rules. Archive or update those rules first; ARCHIVED rules don’t block.
Returns the archived tier on success. Archiving an already-archived tier returns 409 Conflict with code tier_archived. An unknown program or tier returns 404 Not Found.
Authorizations
API key passed in the X-API-Key header.
Response
Archived tier
A tier definition with its levels, lifecycle configuration, and metadata
When the tier was archived (RFC 3339); absent while the tier is ACTIVE
"2024-03-01T00:00:00Z"
When this tier was created (RFC 3339)
"2024-01-15T10:30:00Z"
Human-readable name
"Loyalty Status"
Unique identifier for this tier
"550e8400-e29b-41d4-a716-446655440000"
Tier key used in API calls and rule actions
"status"
Ordered list of levels within this tier
Lifecycle configuration (retention mode, qualification period, downgrade policy, counter rollover)
Program this tier belongs to
"550e8400-e29b-41d4-a716-446655440001"
Lifecycle status: ACTIVE, or ARCHIVED once the tier has been archived
"ACTIVE"
When this tier was last modified (RFC 3339)
"2024-01-15T10:30:00Z"