Activate Tier Structure

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Transitions a tier structure to ACTIVE status. Allowed from: DRAFT, INACTIVE. Cannot activate if the program already has an active/draft tier structure assignment at its limit.

POST /v2/loyalties/tier-structures/{id}/activate

Activate Tier Structure

cURL

curl --request POST \
  --url https://api.voucherify.io/v2/loyalties/tier-structures/{id}/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "card_definition_id": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "object": "tier_structure",
  "point_earned": {
    "period": {
      "value": 2
    }
  },
  "expiration": {
    "rolling_expiration": {
      "period": {
        "value": 2
      }
    },
    "calendar_expiration": {
      "calendar_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "period": {
        "value": 2
      },
      "custom_activity_types": [
        "<string>"
      ]
    }
  },
  "downgrade": {
    "grace_period": {
      "value": 2,
      "round_up": true
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

id · string · required

Unique tier structure identifier.

Response

200

application/json

Activated tier structure

A tier structure resource as returned by the API.

id · string · required

Unique tier structure identifier.

name · string · required

Display name.

Maximum string length: 200

type · enum<string> · required

Tiering model type.

Available options: POINT_BALANCE, POINT_EARNED

card_definition_id · string · required

ID of the linked card definition.

metadata · object · required

Custom key-value metadata.

status · enum<string> · required

Current lifecycle status.

Available options: DRAFT, ACTIVE, INACTIVE, DELETED

created_at · string<date-time> · required

ISO 8601 creation timestamp.

object · enum<string> · required

Object type discriminator.

Available options: tier_structure

point_earned · object | null

Point-earned tracking configuration. Present when type is POINT_EARNED.

Show child attributes

expiration · object | null

Tier qualification expiration settings.

Show child attributes

downgrade · object | null

Downgrade behaviour settings.

Show child attributes

updated_at · string<date-time> | null

ISO 8601 last-update timestamp.