CLcleeng

Transfer a pass [Beta]

Use this endpoint to transfer externally-managed passes between customers.

The life cycle of externally-managed passes is managed outside of Cleeng so it is up to a broadcaster to notify Cleeng about pass status changes, e.g. the change of pass expiration date.

post/passes/{passId}/transfer

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/passes/{passId}/transfer
  • Auth
    API key in header X-Publisher-Token

Path parameters

passIdinteger required

Pass identifier in Cleeng.

Headers

Content-Typestring

application/json

Request body

customerIdinteger required

The identifier of Cleeng customer.

Response

200

passIdinteger
customerIdinteger
statusstring
offerIdstring
expiresAtinteger
paymentMethodIdinteger
externalIdstring
isExternallyManagedboolean
originatedFromunknown
sourcestring

Example response

{
  "passId": 111222333,
  "customerId": 123456789,
  "status": "terminated",
  "offerId": "P123123123_PL",
  "expiresAt": 1727863485,
  "paymentMethodId": 987654321,
  "externalId": "CustomerExternalId",
  "isExternallyManaged": true,
  "replacedBy": {
    "passId": 333222111,
    "reason": "transfer",
    "date": 1727863485
  },
  "source": "samsung"
}

Changes

No recorded changes to this operation across all 1 revision of this API.