v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Update a pass [Beta]

Use this endpoint to update a pass using ID. Only a single property can be updated during one request.

patch/passes/{passId}

Path parameters

passIdinteger required

Pass identifier in Cleeng.

Headers

Content-Typestring

application/json

Request body

expiresAtinteger

Expiration time in UNIX timestamp format. For non-expiring (permanent) passes it must be set to null.

Response

200

passIdinteger

customerIdinteger

statusstring

offerIdstring

{"stackTrail":"paths:/passes/{passId}:patch:responses:200:content:application/json:schema:properties:expiresAt","oasType":"schema","type":"unknown"}

paymentMethodIdinteger

externalIdstring

externalPropertiesobject

isExternallyManagedboolean

sourcestring

Example response

{
  "passId": 123456789,
  "customerId": 123123123,
  "status": "active",
  "offerId": "P987654321_PL",
  "paymentMethodId": 111222333,
  "externalId": "externalId",
  "isExternallyManaged": true,
  "source": "samsung"
}