Update tier structure

curl --request PUT \
  --url https://{cluster}.voucherify.io/v2/loyalties/tier-structures/{tierStructureId} \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "point_balance": {
    "card_definition_id": "<string>"
  },
  "point_earned": {
    "card_definition_id": "<string>",
    "period": {
      "value": 2
    }
  },
  "expiration": {
    "fixed_duration": {
      "period": {
        "value": 2
      }
    },
    "calendar_expiration": {
      "calendar_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "period": {
        "value": 2
      },
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "custom_activity_types": [
        "<string>"
      ]
    }
  },
  "downgrade": {
    "grace_period": {
      "value": 2,
      "round_up": true
    }
  },
  "metadata": {}
}
'

{
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "type": "POINT_BALANCE",
  "expiration": {
    "type": "NO_RETENTION",
    "fixed_duration": {
      "period": {
        "value": 123,
        "unit": "DAY"
      }
    },
    "calendar_expiration": {
      "calendar_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "custom_activity_types": [
        "<string>"
      ],
      "period": {
        "value": 123,
        "unit": "DAY"
      }
    }
  },
  "downgrade": {
    "type": "MULTI_LEVEL",
    "grace_period": {
      "value": 123,
      "unit": "DAY",
      "round_up": true
    }
  },
  "status": "DRAFT",
  "object": "tier_structure",
  "point_balance": {
    "card_definition_id": "<string>"
  },
  "point_earned": {
    "card_definition_id": "<string>",
    "period": {
      "value": 123,
      "unit": "DAY"
    },
    "type": "IMMEDIATELY"
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 500,
  "key": "api_error",
  "message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}

Update tier structure

Documentation in progress

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

Updates a tier structure. All properties are optional; provided values are merged with the existing tier structure. When type is provided as POINT_EARNED, point_earned is required and point_balance must be null; when type is POINT_BALANCE, point_balance is required and point_earned must be null. When the tier structure is not in DRAFT status, only name and metadata may be updated; attempting to update other properties results in a validation error.

PUT

loyalties

tier-structures

{tierStructureId}

Update tier structure

curl --request PUT \
  --url https://{cluster}.voucherify.io/v2/loyalties/tier-structures/{tierStructureId} \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "point_balance": {
    "card_definition_id": "<string>"
  },
  "point_earned": {
    "card_definition_id": "<string>",
    "period": {
      "value": 2
    }
  },
  "expiration": {
    "fixed_duration": {
      "period": {
        "value": 2
      }
    },
    "calendar_expiration": {
      "calendar_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "period": {
        "value": 2
      },
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "custom_activity_types": [
        "<string>"
      ]
    }
  },
  "downgrade": {
    "grace_period": {
      "value": 2,
      "round_up": true
    }
  },
  "metadata": {}
}
'

{
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "type": "POINT_BALANCE",
  "expiration": {
    "type": "NO_RETENTION",
    "fixed_duration": {
      "period": {
        "value": 123,
        "unit": "DAY"
      }
    },
    "calendar_expiration": {
      "calendar_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "custom_activity_types": [
        "<string>"
      ],
      "period": {
        "value": 123,
        "unit": "DAY"
      }
    }
  },
  "downgrade": {
    "type": "MULTI_LEVEL",
    "grace_period": {
      "value": 123,
      "unit": "DAY",
      "round_up": true
    }
  },
  "status": "DRAFT",
  "object": "tier_structure",
  "point_balance": {
    "card_definition_id": "<string>"
  },
  "point_earned": {
    "card_definition_id": "<string>",
    "period": {
      "value": 123,
      "unit": "DAY"
    },
    "type": "IMMEDIATELY"
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 500,
  "key": "api_error",
  "message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Path Parameters

tierStructureId

string

required

Identifies the tier structure. Format lts_[a-f0-9]+.

Pattern: ^lts_[a-f0-9]+$

Body

application/json

Request body schema for PUT /v2/loyalties/tier-structures/{tierStructureId}.

name

string

Display name of the tier structure.

Required string length: 1 - 200

type

enum<string>

Tier qualification tracking model. If provided, the matching tracking settings object (point_balance or point_earned) becomes required.

Available options:

POINT_BALANCE,

POINT_EARNED

point_balance

object | null

Point balance tracking settings. Required (non-null) when type is provided as POINT_BALANCE; must be null when type is provided as POINT_EARNED.

Show child attributes

point_earned

object | null

Points earned tracking settings. Required (non-null) when type is provided as POINT_EARNED; must be null when type is provided as POINT_BALANCE.

Show child attributes

expiration

object | null

Tier membership expiration settings.

Show child attributes

downgrade

object | null

Downgrade behavior applied when tier membership expires.

Show child attributes

metadata

object | null

Free-form key/value object holding custom attributes.

Response

The updated tier structure.

Response body schema for PUT /v2/loyalties/tier-structures/{tierStructureId}.

metadata

object

required

Free-form key/value object holding custom attributes. Defaults to {}.

created_at

string<date-time>

required

Creation timestamp (ISO 8601).

updated_at

string<date-time> | null

required

Last update timestamp (ISO 8601), or null if never updated.

string

required

Unique tier structure identifier.

Pattern: ^lts_[a-f0-9]+$

name

string

required

Display name of the tier structure.

type

enum<string>

required

Tier qualification tracking model.

Available options:

POINT_BALANCE,

POINT_EARNED

expiration

object

required

Tier membership expiration settings.

Show child attributes

downgrade

object

required

Downgrade behavior applied when tier membership expires.

Show child attributes

status

enum<string>

required

Current lifecycle status of the tier structure.

Available options:

DRAFT,

ACTIVE,

INACTIVE,

DELETED

object

string

required

Object type discriminator. Always tier_structure.

Allowed value: "tier_structure"

point_balance

object

Point balance tracking settings. Present only when type is POINT_BALANCE; omitted otherwise.

Show child attributes

point_earned

object

Points earned tracking settings. Present only when type is POINT_EARNED; omitted otherwise.

Show child attributes

Introduction

Endpoints

Events

Update tier structure

Authorizations

Path Parameters

Body

Response