Unlink Loyalty Card From Profile

Unlink customer profile from a loyalty card

POST/v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/unlink_profile

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Unlink Loyalty Card From Profile action (under integration).
Fill in the fields below, then reference the result from later steps as {{unlinkLoyaltyCardFromProfile.response.data}}.

Request

Path parameters

loyaltyProgramIdinteger (int64)required

The identifier of the card-based loyalty program containing the loyalty card. You can get this ID using the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

loyaltyCardIdstringrequired

The identifier of the loyalty card. You can get this ID using the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`.

Request body

Enter the body as JSON in the step's Body field.

integrationIdstringrequired

The integrationId of the customer profile.

json

{
  "integrationId": "R195412"
}

Response

Returns 200 with an object. Read it in later steps with {{unlinkLoyaltyCardFromProfile.response.data.<field>}}.

idinteger (int64)

The internal ID of this entity.

createdstring (date-time)

The time this entity was created.

programIDinteger (int64)

The ID of the loyalty program that owns this entity.

programNamestring

The integration name of the loyalty program that owns this entity.

programTitlestring

The Campaign Manager-displayed name of the loyalty program that owns this entity.

statusstring

Status of the loyalty card. Can be `active` or `inactive`.

blockReasonstring

Reason for transferring and blocking the loyalty card.

identifierstring

The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.

usersPerCardLimitinteger (int64)

The max amount of customer profiles that can be linked to the card. 0 means unlimited.

profilesarray<object>

Integration IDs of the customers profiles linked to the card.

integrationIdstringrequired

Integration ID of the customer profile linked to the card.

timestampstring (date-time)required

Timestamp the customer profile was linked to the card.

ledgerobject

The balance in a Loyalty Program for some Customer.

currentBalancenumberrequired

Sum of currently active points.

pendingBalancenumberrequired

Sum of pending points.

negativeBalancenumber

Sum of negative points. This implies that `currentBalance` is `0`.

expiredBalancenumberrequired

**DEPRECATED** Value is shown as 0.

spentBalancenumberrequired

**DEPRECATED** Value is shown as 0.

tentativeCurrentBalancenumberrequired

The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.

tentativePendingBalancenumber

The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.

tentativeNegativeBalancenumber

The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.

currentTierobject5 fields

pointsToNextTiernumber

Points required to move up a tier.

nextTierNamestring

The name of the next higher tier level in the loyalty program. **Note**: - Returns `null` if the customer has reached the highest available tier. - Returns the lowest level tier name if the customer is not currently assigned to any tier.

subledgersobject

Displays point balances of the card in the subledgers of the loyalty program.

modifiedstring (date-time)

Timestamp of the most recent update of the loyalty card.

oldCardIdentifierstring

The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.

newCardIdentifierstring

The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.

batchIdstring

The ID of the batch in which the loyalty card was created.

json

{
  "id": 6,
  "created": {},
  "programID": 125,
  "status": "active",
  "identifier": "summer-loyalty-card-0543",
  "usersPerCardLimit": 111,
  "programName": "Loyalty_program",
  "programTitle": "Loyalty program",
  "blockReason": "Current card lost. Customer needs a new card.",
  "profiles": [
    {
      "integrationId": "R195412",
      "timestamp": {}
    }
  ],
  "ledger": {
    "pendingBalance": 10,
    "nextTierName": "Silver",
    "negativeBalance": 10,
    "currentBalance": 100,
    "spentBalance": 0,
    "tentativeCurrentBalance": 100,
    "tentativePendingBalance": 20,
    "pointsToNextTier": 20,
    "expiredBalance": 0,
    "currentTier": {
      "expiryDate": {},
      "downgradePolicy": "one_down",
      "name": "bronze",
      "id": 11,
      "startDate": {}
    },
    "tentativeNegativeBalance": 100
  },
  "subledgers": {}
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?