Wallet API Authorization Reference
Find which authentication methods are supported for each Wallet API endpoint.
For information about each authentication method, see Wallet API Security.
Authorization per authentication method
The following table indicates supported authentication methods per endpoint in the Wallet API. See the column for each authentication method to understand what access it allows. For OAuth 2.0, it lists the scope that allows access to the endpoint.
| Name and API Reference | Endpoint | Public | Basic Auth | OAuth 2.0 scope |
|---|---|---|---|---|
| Generate pass from Adaptive Link | GET /pass/adaptive/{adaptiveLinkId}/{deviceType} | ✅ | ❌ | ❌ |
| Generate multiple passes from a single Adaptive Link | GET /pass/adaptive | ✅ | ❌ | ❌ |
| List Adaptive Links | GET /links/adaptive | ❌ | ✅ | ❌ |
| Create Adaptive Link | POST /links/adaptive | ❌ | ✅ | Adaptive Links |
| List Adaptive Links for a project | GET /links/adaptive/projects/{projectId} | ❌ | ✅ | Adaptive Links |
| List Adaptive Links for a template | GET /links/adaptive/projects/{projectId}/templates/{templateId} | ❌ | ✅ | Adaptive Links |
| Get Adaptive Link | GET /links/adaptive/{adaptiveLinkId} | ❌ | ✅ | Adaptive Links |
| Update Adaptive Link | PUT /links/adaptive/{adaptiveLinkId} | ❌ | ✅ | Adaptive Links |
| Delete Adaptive Link | DELETE /links/adaptive/{adaptiveLinkId} | ❌ | ✅ | Adaptive Links |
| Get passes from Adaptive Link | GET /links/adaptive/{adaptiveLinkId}/passes/id/{passExternalId} | ❌ | ✅ | Passes |
| Update passes from Adaptive Link | PUT /links/adaptive/{adaptiveLinkId}/passes/id/{passExternalId} | ❌ | ✅ | Passes |
| List passes for an Adaptive Link | GET /links/adaptive/{adaptiveLinkId}/passes | ❌ | ✅ | Passes |
| Get Adaptive Link from project | GET /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId} | ❌ | ✅ | Adaptive Links |
| Create Adaptive Link in project | POST /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId} | ❌ | ✅ | Adaptive Links |
| Get Adaptive Link | GET /links/adaptive/project/{projectId}/id/{adaptiveLinkExternalId} | ❌ | ✅ | Adaptive Links |
| Create Adaptive Link | POST /links/adaptive/project/{projectId}/id/{adaptiveLinkExternalId} | ❌ | ✅ | Adaptive Links |
| Get pass from Adaptive Link | GET /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId}/passes/id/{passExternalId} | ❌ | ✅ | Passes |
| Update passes from Adaptive Link for an external project | PUT /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId}/passes/id/{passExternalId} | ❌ | ✅ | Passes |
| Create boarding pass or event ticket Adaptive Links | POST /links/adaptive/multiple/project/{projectId} | ❌ | ✅ | Adaptive Links |
| List passes for an Adaptive Link for a project | GET /links/adaptive/project/{projectId}/id/{adaptiveLinkExternalId}/passes | ❌ | ✅ | Passes |
| List passes for an Adaptive Link for an external project | GET /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId}/passes | ❌ | ✅ | Adaptive Links |
| List certificates | GET /certificates | ❌ | ✅ | ❌ |
| Add new certificate | POST /certificates | ❌ | ✅ | ❌ |
| Get certificate | GET /certificates/{id} | ❌ | ✅ | ❌ |
| Update certificate | PUT /certificates/{id} | ❌ | ✅ | ❌ |
| Remove certificate | DELETE /certificates/{id} | ❌ | ✅ | ❌ |
| List pass groups for event | GET /events/project/{projectId}/{eventId}/passGroups | ❌ | ✅ | Events |
| Add event to pass group | POST /events/project/{projectId}/{eventId}/passGroups | ❌ | ✅ | Events |
| Remove event from pass group | DELETE /events/project/{projectId}/{eventId}/passGroups/{passGroup} | ❌ | ✅ | Events |
| Update events in a pass group | PUT /events/project/{projectId}/passGroups/{passGroup} | ❌ | ✅ | Events |
| Create event | POST /events/project/{projectId} | ❌ | ✅ | Events |
| Create event with external ID | POST /events/project/id/{projectExternalId}/id/{eventExternalId} | ❌ | ✅ | Events |
| Get event | GET /events/project/{projectId}/{eventId} | ❌ | ✅ | Events |
| Update event | PUT /events/project/{projectId}/{eventId} | ❌ | ✅ | Events |
| Delete event | DELETE /events/project/{projectId}/{eventId} | ❌ | ✅ | Events |
| List event passes | GET /events/project/{projectId}/{eventId}/passes | ❌ | ✅ | Passes |
| List pass groups for a flight | GET /flights/project/{projectId}/{flightId}/passGroups | ❌ | ✅ | Flights |
| Add flight to a pass group | POST /flights/project/{projectId}/{flightId}/passGroups | ❌ | ✅ | Flights |
| Remove flight from pass group | DELETE /flights/project/{projectId}/{flightId}/passGroups/{passGroup} | ❌ | ✅ | Flights |
| Update flights in a pass group | PUT /flights/project/{projectId}/passGroups/{passGroup} | ❌ | ✅ | Flights |
| Update flights with external ID in a pass group | PUT /flights/project/id/{projectExternalId}/id/passGroups/{passGroup} | ❌ | ✅ | Flights |
| Create flight | POST /flights/project/{projectId} | ❌ | ✅ | Flights |
| Get flight | GET /flights/project/{projectId}/{flightId} | ❌ | ✅ | Flights |
| Update flight | PUT /flights/project/{projectId}/{flightId} | ❌ | ✅ | Flights |
| Delete flight | DELETE /flights/project/{projectId}/{flightId} | ❌ | ✅ | Flights |
| Create flight with external ID | POST /flights/project/id/{projectExternalId}/id/{flightExternalId} | ❌ | ✅ | Flights |
| List flight passes | GET /flights/project/{projectId}/{flightId}/passes | ❌ | ✅ | Passes |
| Send notification by pass | POST /pass/{passId}/notify | ❌ | ✅ | Notifications |
| Delete notification by pass | DELETE /pass/{passId}/notify | ❌ | ✅ | Notifications |
| Send notification by pass with external ID | POST /pass/template/{templateId}/id/{passExternalId}/notify | ❌ | ✅ | Notifications |
| Delete notification by pass with external ID | DELETE /pass/template/{templateId}/id/{passExternalId}/notify | ❌ | ✅ | Notifications |
| Send notification by segment | POST /segments/{projectId}/{segmentId}/notify | ❌ | ✅ | Notifications |
| Delete notification by segment | DELETE /segments/{projectId}/{segmentId}/notify | ❌ | ✅ | Notifications |
| Send notification by tag | POST /tag/{tag}/notify | ❌ | ✅ | Notifications |
| Delete notification by tag | DELETE /tag/{tag}/notify | ❌ | ✅ | Notifications |
| Send notification by template | POST /template/{templateId}/notify | ❌ | ✅ | Notifications |
| Delete notification by template | DELETE /template/{templateId}/notify | ❌ | ✅ | Notifications |
| Request token | POST /token | ❌ | ❌ | ❌ |
| Verify public key | GET /verify/public_key/{kid} | ✅ | ❌ | ❌ |
| Generates a pass | POST /pass/{id}/dynamic | ❌ | ✅ | Passes |
| Get pass | GET /pass/{id} | ❌ | ✅ | Passes |
| Create pass | POST /pass/{id} | ❌ | ✅ | Passes |
| Update pass | PUT /pass/{id} | ❌ | ✅ | Passes |
| Delete pass | DELETE /pass/{id} | ❌ | ✅ | Passes |
| View Apple Wallet JSON | GET /pass/{passId}/viewJSONPass | ❌ | ✅ | Passes |
| View Apple Wallet JSON with external ID | GET /pass/id/{passExternalId}/viewJSONPass | ❌ | ✅ | Passes |
| Download Apple Wallet .pkpass | GET /pass/{passId}/download | ❌ | ✅ | Passes |
| Download multiple Apple Wallet Passes in a single .pkpass file | GET /pass/download | ❌ | ✅ | Passes |
| Save to Google Wallet | POST /pass/{templateId}/saveToWallet | ❌ | ✅ | Passes |
| Get pass | GET /pass/template/{templateId}/id/{passExternalId} | ❌ | ✅ | Passes |
| Create pass | POST /pass/template/{templateId}/id/{passExternalId} | ❌ | ✅ | Passes |
| Update pass for a template | PUT /pass/template/{templateId}/id/{passExternalId} | ❌ | ✅ | Passes |
| Delete pass | DELETE /pass/template/{templateId}/id/{passExternalId} | ❌ | ✅ | Passes |
| Download Apple Wallet .pkpass with external ID | GET /pass/template/{templateId}/id/{passExternalId}/download | ❌ | ✅ | Passes |
| Download multiple Apple Wallet Passes with external IDs in a single .pkpass file | GET /pass/template/{templateId}/download | ❌ | ✅ | Passes |
| List tags for pass with external ID | GET /pass/template/{templateId}/id/{passExternalId}/tags | ❌ | ✅ | Passes |
| Update tags for pass with external ID | PUT /pass/template/{templateId}/id/{passExternalId}/tags | ❌ | ✅ | Passes |
| Add locations to pass | POST /pass/template/{templateId}/id/{passExternalId}/locations | ❌ | ✅ | Passes |
| Delete locations from pass | DELETE /pass/template/{templateId}/id/{passExternalId}/location/{locationId} | ❌ | ✅ | Passes |
| List beacons on Apple Wallet pass | GET /pass/template/{templateId}/id/{passExternalId}/beacons | ❌ | ✅ | Passes |
| Add or update beacons for Apple Wallet pass | PUT /pass/template/{templateId}/id/{passExternalId}/beacons | ❌ | ✅ | Passes |
| Get messages for Google Pass | GET /pass/{passId}/message | ❌ | ✅ | Passes |
| Add message to Google Pass | POST /pass/{passId}/message | ❌ | ✅ | Passes |
| Get messages for Google Pass with external ID | GET /pass/template/{templateId}/id/{passExternalId}/message | ❌ | ✅ | Passes |
| Add message to Google Pass with external ID | POST /pass/template/{templateId}/id/{passExternalId}/message | ❌ | ✅ | Passes |
| Update pass | PUT /pass/id/{externalId} | ❌ | ✅ | Passes |
| Create pass from a template | POST /pass/id/{templateExternalId}/id/{passExternalId} | ❌ | ✅ | Passes |
| Add locations to pass | POST /pass/{passId}/locations | ❌ | ✅ | Passes |
| Delete locations from pass | DELETE /pass/{passId}/location/{passLocationId} | ❌ | ✅ | Passes |
| List passes | GET /pass | ❌ | ✅ | Passes |
| List projects | GET /project | ❌ | ✅ | ❌ |
| Create project | POST /project | ❌ | ✅ | ❌ |
| Create project with external ID | POST /project/id/{externalId} | ❌ | ✅ | ❌ |
| Get project | GET /project/{projectId} | ❌ | ✅ | ❌ |
| Update project | PUT /project/{projectId} | ❌ | ✅ | ❌ |
| List NFC merchants | GET /project/{projectId}/nfcMerchants | ❌ | ✅ | Projects |
| Add NFC merchant | POST /project/{projectId}/nfcMerchants | ❌ | ✅ | Projects |
| Get NFC merchant | GET /project/{projectId}/nfcMerchants/{merchantId} | ❌ | ✅ | Projects |
| Update NFC merchant information | PUT /project/{projectId}/nfcMerchants/{merchantId} | ❌ | ✅ | Projects |
| Delete NFC merchant | DELETE /project/{projectId}/nfcMerchants/{merchantId} | ❌ | ✅ | Projects |
| Duplicate project | POST /project/duplicate/{projectId} | ❌ | ✅ | ❌ |
| List schedules | GET /schedules/{projectId} | ❌ | ✅ | Schedules |
| Schedule an update or push notification | POST /schedules/{projectId} | ❌ | ✅ | Schedules |
| Get schedule | GET /schedules/{projectId}/{scheduleId} | ❌ | ✅ | Schedules |
| Update schedule | PUT /schedules/{projectId}/{scheduleId} | ❌ | ✅ | Schedules |
| Delete schedule | DELETE /schedules/{projectId}/{scheduleId} | ❌ | ✅ | Schedules |
| List segments | GET /segments/{projectId} | ❌ | ✅ | Segments |
| Create segment | POST /segments/{projectId} | ❌ | ✅ | Segments |
| Look up segment | GET /segments/{projectId}/{segmentId} | ❌ | ✅ | Segments |
| Update segment | PUT /segments/{projectId}/{segmentId} | ❌ | ✅ | Segments |
| Delete segment | DELETE /segments/{projectId}/{segmentId} | ❌ | ✅ | Segments |
| Update passes by segment | PUT /segments/{projectId}/{segmentId}/passes | ❌ | ✅ | Passes |
| Template statistics | GET /template/{templateId}/stats | ❌ | ✅ | Statistics |
| Template activity | GET /template/{templateId}/activity | ❌ | ✅ | Statistics |
| Project statistics | GET /project/{projectId}/stats | ❌ | ✅ | Statistics |
| Project activity | GET /project/{projectId}/activity | ❌ | ✅ | Statistics |
| Tag statistics | GET /tag/{tag}/stats | ❌ | ✅ | Statistics |
| Pass statistics with external ID | GET /pass/id/{externalId}/stats | ❌ | ✅ | Statistics |
| List tags for pass | GET /pass/{passId}/tags | ❌ | ✅ | Passes |
| Add tags to pass | PUT /pass/{passId}/tags | ❌ | ✅ | Passes |
| List all tags | GET /tag | ❌ | ✅ | ❌ |
| List passes for a tag | GET /tag/{tag}/passes | ❌ | ✅ | Passes |
| Update passes by tag | PUT /tag/{tag}/passes | ❌ | ✅ | Passes |
| Remove tag from all passes | DELETE /tag/{tag}/passes | ❌ | ✅ | Passes |
| Remove tag from a pass | DELETE /tag/{tag}/pass/{pass} | ❌ | ✅ | Passes |
| Delete tag | DELETE /tag/{tag} | ❌ | ✅ | ❌ |
| Get template | GET /template/{id} | ❌ | ✅ | Templates |
| Create template | POST /template/{id} | ❌ | ✅ | Templates |
| Update template | PUT /template/{id} | ❌ | ✅ | Templates |
| Delete template | DELETE /template/{id} | ❌ | ✅ | Templates |
| Get template v2 | GET /templates/{id} | ❌ | ✅ | Templates |
| Update template v2 | PUT /templates/{id} | ❌ | ✅ | Templates |
| Patch template | PATCH /templates/{id} | ❌ | ✅ | Templates |
| Create template with external ID | POST /template/{projectId}/id/{templateExternalId} | ❌ | ✅ | Templates |
| List templates | GET /template/headers | ❌ | ✅ | Templates |
| Duplicate template | POST /template/duplicate/{templateId} | ❌ | ✅ | Templates |
| Add locations to template | POST /template/{templateId}/locations | ❌ | ✅ | Templates |
| Delete location from template | DELETE /template/{templateId}/location/{locationId} | ❌ | ✅ | Templates |
| Get personalization requirements | GET /template/{templateId}/personalization | ❌ | ✅ | Templates |
| Add personalization requirements | POST /template/{templateId}/personalization | ❌ | ✅ | Templates |
| Update personalization requirements | PUT /template/{templateId}/personalization | ❌ | ✅ | Templates |
| Delete personalization requirements | DELETE /template/{templateId}/personalization | ❌ | ✅ | Templates |
| Get template passes | GET /template/{templateId}/passes | ❌ | ✅ | Passes |
| Publish a bulk update to passes | PUT /template/{templateId}/passes | ❌ | ✅ | Passes |
| Get ticket status | GET /ticket/{ticketId} | ❌ | ✅ | ❌ |
| Check system status | GET /system/status | ❌ | ✅ | ❌ |
| Get callback specification | GET /project/{projectId}/settings/callback | ❌ | ✅ | ❌ |
| Create callback specification | POST /project/{projectId}/settings/callback | ❌ | ✅ | ❌ |
| Update callback specification | PUT /project/{projectId}/settings/callback | ❌ | ✅ | ❌ |
| Delete callback specification | DELETE /project/{projectId}/settings/callback | ❌ | ✅ | ❌ |
OAuth token scopes
Refer to the following sections when setting permissions for OAuth client credentials.
Adaptive Links
The Adaptive Links (wadl) scope includes endpoints for managing adaptive links.
| Name | Endpoint |
|---|---|
| Create Adaptive Link | POST /links/adaptive |
| Create boarding pass or event ticket Adaptive Links | POST /links/adaptive/multiple/project/{projectId} |
| Get Adaptive Link from project | GET /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId} |
| Create Adaptive Link in project | POST /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId} |
| List passes for an Adaptive Link for an external project | GET /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId}/passes |
| Get Adaptive Link | GET /links/adaptive/project/{projectId}/id/{adaptiveLinkExternalId} |
| Create Adaptive Link | POST /links/adaptive/project/{projectId}/id/{adaptiveLinkExternalId} |
| List Adaptive Links for a project | GET /links/adaptive/projects/{projectId} |
| List Adaptive Links for a template | GET /links/adaptive/projects/{projectId}/templates/{templateId} |
| Get Adaptive Link | GET /links/adaptive/{adaptiveLinkId} |
| Update Adaptive Link | PUT /links/adaptive/{adaptiveLinkId} |
| Delete Adaptive Link | DELETE /links/adaptive/{adaptiveLinkId} |
Events
The Events (wevt) scope includes endpoints for managing events.
| Name | Endpoint |
|---|---|
| Create event with external ID | POST /events/project/id/{projectExternalId}/id/{eventExternalId} |
| Create event | POST /events/project/{projectId} |
| Update events in a pass group | PUT /events/project/{projectId}/passGroups/{passGroup} |
| Get event | GET /events/project/{projectId}/{eventId} |
| Update event | PUT /events/project/{projectId}/{eventId} |
| Delete event | DELETE /events/project/{projectId}/{eventId} |
| List pass groups for event | GET /events/project/{projectId}/{eventId}/passGroups |
| Add event to pass group | POST /events/project/{projectId}/{eventId}/passGroups |
| Remove event from pass group | DELETE /events/project/{projectId}/{eventId}/passGroups/{passGroup} |
Flights
The Flights (wfli) scope includes endpoints for managing flights.
| Name | Endpoint |
|---|---|
| Update flights with external ID in a pass group | PUT /flights/project/id/{projectExternalId}/id/passGroups/{passGroup} |
| Create flight with external ID | POST /flights/project/id/{projectExternalId}/id/{flightExternalId} |
| Create flight | POST /flights/project/{projectId} |
| Update flights in a pass group | PUT /flights/project/{projectId}/passGroups/{passGroup} |
| Get flight | GET /flights/project/{projectId}/{flightId} |
| Update flight | PUT /flights/project/{projectId}/{flightId} |
| Delete flight | DELETE /flights/project/{projectId}/{flightId} |
| List pass groups for a flight | GET /flights/project/{projectId}/{flightId}/passGroups |
| Add flight to a pass group | POST /flights/project/{projectId}/{flightId}/passGroups |
| Remove flight from pass group | DELETE /flights/project/{projectId}/{flightId}/passGroups/{passGroup} |
Notifications
The Notifications (wnot) scope includes endpoints for managing notifications.
| Name | Endpoint |
|---|---|
| Send notification by pass with external ID | POST /pass/template/{templateId}/id/{passExternalId}/notify |
| Delete notification by pass with external ID | DELETE /pass/template/{templateId}/id/{passExternalId}/notify |
| Send notification by pass | POST /pass/{passId}/notify |
| Delete notification by pass | DELETE /pass/{passId}/notify |
| Send notification by segment | POST /segments/{projectId}/{segmentId}/notify |
| Delete notification by segment | DELETE /segments/{projectId}/{segmentId}/notify |
| Send notification by tag | POST /tag/{tag}/notify |
| Delete notification by tag | DELETE /tag/{tag}/notify |
| Send notification by template | POST /template/{templateId}/notify |
| Delete notification by template | DELETE /template/{templateId}/notify |
Passes
The Passes (wpas) scope includes endpoints for managing passes.
| Name | Endpoint |
|---|---|
| List event passes | GET /events/project/{projectId}/{eventId}/passes |
| List flight passes | GET /flights/project/{projectId}/{flightId}/passes |
| Get pass from Adaptive Link | GET /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId}/passes/id/{passExternalId} |
| Update passes from Adaptive Link for an external project | PUT /links/adaptive/project/id/{projectExternalId}/id/{adaptiveLinkExternalId}/passes/id/{passExternalId} |
| List passes for an Adaptive Link for a project | GET /links/adaptive/project/{projectId}/id/{adaptiveLinkExternalId}/passes |
| List passes for an Adaptive Link | GET /links/adaptive/{adaptiveLinkId}/passes |
| Get passes from Adaptive Link | GET /links/adaptive/{adaptiveLinkId}/passes/id/{passExternalId} |
| Update passes from Adaptive Link | PUT /links/adaptive/{adaptiveLinkId}/passes/id/{passExternalId} |
| List passes | GET /pass |
| Download multiple Apple Wallet Passes in a single .pkpass file | GET /pass/download |
| Update pass | PUT /pass/id/{externalId} |
| View Apple Wallet JSON with external ID | GET /pass/id/{passExternalId}/viewJSONPass |
| Create pass from a template | POST /pass/id/{templateExternalId}/id/{passExternalId} |
| Download multiple Apple Wallet Passes with external IDs in a single .pkpass file | GET /pass/template/{templateId}/download |
| Get pass | GET /pass/template/{templateId}/id/{passExternalId} |
| Create pass | POST /pass/template/{templateId}/id/{passExternalId} |
| Update pass for a template | PUT /pass/template/{templateId}/id/{passExternalId} |
| Delete pass | DELETE /pass/template/{templateId}/id/{passExternalId} |
| List beacons on Apple Wallet pass | GET /pass/template/{templateId}/id/{passExternalId}/beacons |
| Add or update beacons for Apple Wallet pass | PUT /pass/template/{templateId}/id/{passExternalId}/beacons |
| Download Apple Wallet .pkpass with external ID | GET /pass/template/{templateId}/id/{passExternalId}/download |
| Delete locations from pass | DELETE /pass/template/{templateId}/id/{passExternalId}/location/{locationId} |
| Add locations to pass | POST /pass/template/{templateId}/id/{passExternalId}/locations |
| Get messages for Google Pass with external ID | GET /pass/template/{templateId}/id/{passExternalId}/message |
| Add message to Google Pass with external ID | POST /pass/template/{templateId}/id/{passExternalId}/message |
| List tags for pass with external ID | GET /pass/template/{templateId}/id/{passExternalId}/tags |
| Update tags for pass with external ID | PUT /pass/template/{templateId}/id/{passExternalId}/tags |
| Get pass | GET /pass/{id} |
| Create pass | POST /pass/{id} |
| Update pass | PUT /pass/{id} |
| Delete pass | DELETE /pass/{id} |
| Generates a pass | POST /pass/{id}/dynamic |
| Download Apple Wallet .pkpass | GET /pass/{passId}/download |
| Delete locations from pass | DELETE /pass/{passId}/location/{passLocationId} |
| Add locations to pass | POST /pass/{passId}/locations |
| Get messages for Google Pass | GET /pass/{passId}/message |
| Add message to Google Pass | POST /pass/{passId}/message |
| List tags for pass | GET /pass/{passId}/tags |
| Add tags to pass | PUT /pass/{passId}/tags |
| View Apple Wallet JSON | GET /pass/{passId}/viewJSONPass |
| Save to Google Wallet | POST /pass/{templateId}/saveToWallet |
| Update passes by segment | PUT /segments/{projectId}/{segmentId}/passes |
| Remove tag from a pass | DELETE /tag/{tag}/pass/{pass} |
| List passes for a tag | GET /tag/{tag}/passes |
| Update passes by tag | PUT /tag/{tag}/passes |
| Remove tag from all passes | DELETE /tag/{tag}/passes |
| Get template passes | GET /template/{templateId}/passes |
| Publish a bulk update to passes | PUT /template/{templateId}/passes |
Projects
The Projects (wprj) scope includes endpoints for managing projects.
| Name | Endpoint |
|---|---|
| List NFC merchants | GET /project/{projectId}/nfcMerchants |
| Add NFC merchant | POST /project/{projectId}/nfcMerchants |
| Get NFC merchant | GET /project/{projectId}/nfcMerchants/{merchantId} |
| Update NFC merchant information | PUT /project/{projectId}/nfcMerchants/{merchantId} |
| Delete NFC merchant | DELETE /project/{projectId}/nfcMerchants/{merchantId} |
Schedules
The Schedules (wsch) scope includes endpoints for managing schedules.
| Name | Endpoint |
|---|---|
| List schedules | GET /schedules/{projectId} |
| Schedule an update or push notification | POST /schedules/{projectId} |
| Get schedule | GET /schedules/{projectId}/{scheduleId} |
| Update schedule | PUT /schedules/{projectId}/{scheduleId} |
| Delete schedule | DELETE /schedules/{projectId}/{scheduleId} |
Segments
The Segments (wseg) scope includes endpoints for managing segments.
| Name | Endpoint |
|---|---|
| List segments | GET /segments/{projectId} |
| Create segment | POST /segments/{projectId} |
| Look up segment | GET /segments/{projectId}/{segmentId} |
| Update segment | PUT /segments/{projectId}/{segmentId} |
| Delete segment | DELETE /segments/{projectId}/{segmentId} |
Statistics
The Statistics (wrpt) scope includes endpoints for managing statistics.
| Name | Endpoint |
|---|---|
| Pass statistics with external ID | GET /pass/id/{externalId}/stats |
| Project activity | GET /project/{projectId}/activity |
| Project statistics | GET /project/{projectId}/stats |
| Tag statistics | GET /tag/{tag}/stats |
| Template activity | GET /template/{templateId}/activity |
| Template statistics | GET /template/{templateId}/stats |
Templates
The Templates (wtmp) scope includes endpoints for managing templates.
| Name | Endpoint |
|---|---|
| Duplicate template | POST /template/duplicate/{templateId} |
| List templates | GET /template/headers |
| Get template | GET /template/{id} |
| Create template | POST /template/{id} |
| Update template | PUT /template/{id} |
| Delete template | DELETE /template/{id} |
| Create template with external ID | POST /template/{projectId}/id/{templateExternalId} |
| Delete location from template | DELETE /template/{templateId}/location/{locationId} |
| Add locations to template | POST /template/{templateId}/locations |
| Get personalization requirements | GET /template/{templateId}/personalization |
| Add personalization requirements | POST /template/{templateId}/personalization |
| Update personalization requirements | PUT /template/{templateId}/personalization |
| Delete personalization requirements | DELETE /template/{templateId}/personalization |
| Get template v2 | GET /templates/{id} |
| Update template v2 | PUT /templates/{id} |
| Patch template | PATCH /templates/{id} |