Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yuko.so/llms.txt

Use this file to discover all available pages before exploring further.

A VIP tier change is a record of a customer moving from one tier to another within Yuko’s loyalty program. Tier changes are stored as loyalty activity records with activity_type set to tier_changed. They are automatically created when a customer’s points balance or purchase history causes them to qualify for a different tier. uuid string<uuid> Unique identifier for the tier change activity. Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890" org_uuid string<uuid> The UUID of the organisation this tier change belongs to. Example: "ed39de7b-6c31-46bc-af56-ef51676a08e0" customer_uuid string<uuid> The UUID of the customer whose tier changed. Example: "a02a4ad4-22c3-4f46-95fb-497e10f3e7d3" activity_type string The type of activity. Always tier_changed for VIP tier change records. Example: "tier_changed" source_type string The source that triggered the tier change. Example: "loyalty_tiers" source_uuid string<uuid> The UUID of the tier that triggered this change. Example: "7fb39c85-3a3f-4247-8333-2e05a9c8ae28" activity_value object A structured object containing the full details of the tier change. Hide child attributes activity_value.change_type enum<string> The nature of the tier change. Available options: tier_assigned, tier_upgraded, tier_downgraded, tier_lost Example: "tier_upgraded" activity_value.previous_tier object | null The tier the customer was in before the change. null if the customer had no tier. Show child attributes activity_value.previous_tier.uuid string<uuid> The UUID of the previous tier. Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6" activity_value.previous_tier.name string The name of the previous tier. Example: "Silver" activity_value.previous_tier.threshold_value integer The points threshold of the previous tier. Example: 0 activity_value.current_tier object The tier the customer moved into as a result of the change. Show child attributes activity_value.current_tier.uuid string<uuid> The UUID of the current tier. Example: "7fb39c85-3a3f-4247-8333-2e05a9c8ae28" activity_value.current_tier.name string The name of the current tier. Example: "Gold" activity_value.current_tier.threshold_value integer The points threshold of the current tier. Example: 500 activity_value.changed_at string<date-time> The date and time when the tier change occurred. Example: "2025-12-17T12:36:33.000Z" activity_value.context object | null Additional context about what triggered the tier change (e.g. order details or points update). Example: null created_at string<date-time> The date and time when the tier change record was created. Example: "2025-12-17T12:36:33.000Z" updated_at string<date-time> The date and time when the tier change record was last updated. Example: "2025-12-17T12:36:33.000Z"