Loyalty Admin API

Enum

ForceUnlock1

Controls how strictly source completion limits are enforced for the <code>complete_source</code> adjustment action.

By default, all configured limits (single-use, mutual exclusions, rate limits) are enforced. Use the other values in customer support scenarios where overriding specific limits is appropriate.

Kind Enum type
Used in AdjustCustomerState3

Values

  • normally

    Enforce all configured limits. This is the default.

    Source completion is allowed only if the customer has not already used the source (unless it allows multiple uses), no mutual exclusion is triggered, and no rate limit has been exceeded. This is the same behavior as omitting the field entirely.

  • force_if_first

    Only reject if this specific source was previously completed by this customer.

    Bypasses mutual exclusion checks and rate limit checks. The source is granted as long as the customer has never completed it before.

    This is useful when a source is blocked by a mutual exclusion or rate limit, but you still want to allow a first-time completion for a specific customer.

  • force_again

    Always grant the source, regardless of any limits.

    Skips all checks entirely. The source is granted even if the customer has already completed it and even if it does not allow multiple uses.

    Use with caution: this can grant duplicate rewards if applied to a source the customer has already completed.

Previous
CustomerMark1