GuideWalletBatch
Wallet updates
Monitor and cancel batch push update operations from the admin console.
Wallet updates
Reading the table
Column
What it shows
Tracking a specific batch with correlationId
POST /api/{tenantId}/passes/pushUpdate
?filter[0].field=passType&filter[0].operator=equals&filter[0].value=loyalty
{
"additionalData": { "offer": "summer2025", "discount": "20%" },
"options": {
"updateMetadata": true,
"throughput": 12,
"correlationId": "campaign-summer-2025"
}
}Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Query parameters
Body
additionalDataobject · nullableOptional
Arbitrary data to persist with the pass (for example, loyalty tier, store code, or campaign flags).
passTypestring · nullableOptional
Optional pass type to convert the pass to.
updateMetadatabooleanOptionalDeprecatedDefault:
Specifies if passes metadata should be updated. Updating metadata is time consuming and could be avoided for notification only push update
falseResponses
200
Passes scheduled for update; returns the count in the response body.
Result returned after scheduling a bulk push update operation.
passCountinteger · int32Optional
Count of passes scheduled for update.
post/api/{tenantId}/passes/pushUpdate
200
Passes scheduled for update; returns the count in the response body.
Cancelling a running operation
Operation names
Last updated

