Skip to main content
PUT
/
v2
/
loyalty
/
programs
/
{programId}
/
vouchers
/
{voucherId}
/
card
Update Loyalty Program Voucher Card
curl --request PUT \
  --url https://api.loyalty.dog/v2/loyalty/programs/{programId}/vouchers/{voucherId}/card \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "",
  "suppressStripShine": true,
  "sharing": {
    "method": "PKPassSharingMethodDisabled",
    "url": "<string>",
    "text": "<string>"
  },
  "appLaunchURL": "<string>",
  "associatedApps": [
    {}
  ],
  "associatedStoreIdentifiers": [
    123
  ],
  "associatedPlayIdentifiers": [
    "<string>"
  ],
  "beacons": [
    {
      "proximityUUID": "<string>",
      "major": 123,
      "minor": 123,
      "relevantText": "<string>"
    }
  ],
  "locations": [
    {
      "latitude": 0,
      "longitude": 0,
      "altitude": 0,
      "distance": 123,
      "relevantText": "<string>"
    }
  ],
  "barcodes": [
    {
      "message": "<string>",
      "messageEncoding": "iso-8859-1",
      "altText": "<string>",
      "verifier": true,
      "disabled": true
    }
  ],
  "barcode": {
    "message": "<string>",
    "messageEncoding": "iso-8859-1",
    "altText": "<string>",
    "verifier": true,
    "disabled": true
  },
  "labelColor": "<string>",
  "backgroundColor": "<string>",
  "foregroundColor": "<string>",
  "logoText": "<string>",
  "relevantDate": "2023-11-07T05:31:56Z",
  "expirationDate": "2023-11-07T05:31:56Z",
  "voided": true,
  "userInfo": {},
  "generic": {
    "headerFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "primaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "secondaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "backFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "auxiliaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ]
  },
  "coupon": {
    "headerFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "primaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "secondaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "backFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "auxiliaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ]
  },
  "storeCard": {
    "headerFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "primaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "secondaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "backFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "auxiliaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ]
  },
  "eventTicket": {
    "headerFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "primaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "secondaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "backFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "auxiliaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ]
  },
  "boardingPass": {
    "headerFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "primaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "secondaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "backFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ],
    "auxiliaryFields": [
      {
        "key": "<string>",
        "value": "<string>",
        "label": "<string>",
        "attributedValue": "<string>",
        "changeMessage": "<string>",
        "dataDetectorTypes": [],
        "isRelative": true,
        "ignoresTimeZone": true,
        "currencyCode": "<string>",
        "googleHideOnCard": true,
        "googleHideOnBack": true,
        "googleFieldType": "<string>",
        "googleUri": "<string>",
        "googleLabel": "<string>",
        "googleValue": "<string>"
      }
    ]
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

​
authorization
string | null

Path Parameters

​
voucherId
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

​
programId
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json
​
description
string | null
default:""
​
suppressStripShine
boolean | null
​
sharing
PassSharing · object
​
appLaunchURL
string | null
​
associatedApps
Associatedapps · object[]
​
associatedStoreIdentifiers
integer[]
​
associatedPlayIdentifiers
string[]
​
beacons
PassBeacon · object[]
​
locations
PassLocation · object[]
​
barcodes
PassBarcode · object[]
​
barcode
PassBarcode · object
​
labelColor
string | null
​
backgroundColor
string | null
​
foregroundColor
string | null
​
logoText
string | null
​
relevantDate
string<date-time> | null
​
expirationDate
string<date-time> | null
​
voided
boolean | null
​
userInfo
Userinfo · object
​
generic
PassInformation · object
​
coupon
PassInformation · object
​
storeCard
PassInformation · object
​
eventTicket
PassInformation · object
​
boardingPass
PassInformation · object

Response

Successful Response