Update program pass template
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userInfo: {},
backFields: [{}],
associatedStoreIdentifiers: ['<string>'],
description: '<string>',
publicKey: '<string>',
auxiliaryFields: [{}],
enableGoogleSmartTap: true,
colors: {
backgroundColor: '<string>',
foregroundColor: '<string>',
stripColor: '<string>',
labelColor: '<string>'
},
sharingProhibited: true,
defaultLanguage: '<string>',
supportedLanguages: ['<string>'],
headerFields: [{}],
expirationDate: '<string>',
logoText: '<string>',
organizationName: '<string>',
relevantDates: [{endDate: '<string>', relevantDate: '<string>', startDate: '<string>'}],
secondaryFields: [{}],
semanticTags: {
eventLiveMessage: '<string>',
leagueAbbreviation: '<string>',
venuePhoneNumber: '<string>',
priorityStatus: '<string>',
tailgatingAllowed: true,
seats: [
{
seatIdentifier: '<string>',
seatType: '<string>',
seatDescription: '<string>',
seatSection: '<string>',
seatRow: '<string>',
seatAisle: '<string>',
seatSectionColor: '<string>',
seatNumber: '<string>',
seatLevel: '<string>'
}
],
attendeeName: '<string>',
leagueName: '<string>',
securityScreening: '<string>',
venueEntrance: '<string>',
destinationGate: '<string>',
playlistIDs: ['<string>'],
eventName: '<string>',
vehicleNumber: '<string>',
airplay: [{airPlayDeviceGroupToken: '<string>'}],
homeTeamLocation: '<string>',
silenceRequested: true,
awayTeamAbbreviation: '<string>',
departureAirportCode: '<string>',
vehicleType: '<string>',
departurePlatform: '<string>',
awayTeamLocation: '<string>',
destinationLocationDescription: '<string>',
boardingSequenceNumber: '<string>',
venueEntrancePortal: '<string>',
additionalTicketAttributes: '<string>',
destinationAirportName: '<string>',
membershipProgramNumber: '<string>',
venueOpenDate: '2023-11-07T05:31:56Z',
admissionLevelAbbreviation: '<string>',
currentBoardingDate: '2023-11-07T05:31:56Z',
flightNumber: 123,
artistIDs: ['<string>'],
carNumber: '<string>',
venueName: '<string>',
confirmationNumber: '<string>',
venueParkingLotsOpenDate: '2023-11-07T05:31:56Z',
originalBoardingDate: '2023-11-07T05:31:56Z',
awayTeamName: '<string>',
albumIDs: ['<string>'],
destinationPlatform: '<string>',
homeTeamAbbreviation: '<string>',
sportName: '<string>',
departureAirportName: '<string>',
wifiAccess: [{password: '<string>', ssid: '<string>'}],
eventStartDate: '2023-11-07T05:31:56Z',
passengerName: {
namePrefix: '<string>',
familyName: '<string>',
givenName: '<string>',
nickname: '<string>',
nameSuffix: '<string>',
middleName: '<string>',
phoneticRepresentation: '<string>'
},
destinationAirportCode: '<string>',
vehicleName: '<string>',
entranceDescription: '<string>',
departureGate: '<string>',
venueEntranceGate: '<string>',
venueRoom: '<string>',
venueFanZoneOpenDate: '2023-11-07T05:31:56Z',
venueBoxOfficeOpenDate: '2023-11-07T05:31:56Z',
departureLocationDescription: '<string>',
originalDepartureDate: '2023-11-07T05:31:56Z',
duration: 123,
boardingGroup: '<string>',
currentDepartureDate: '2023-11-07T05:31:56Z',
destinationTerminal: '<string>',
genre: '<string>',
airlineCode: '<string>',
currentArrivalDate: '2023-11-07T05:31:56Z',
admissionLevel: '<string>',
originalArrivalDate: '2023-11-07T05:31:56Z',
eventEndDate: '2023-11-07T05:31:56Z',
departureTerminal: '<string>',
membershipProgramName: '<string>',
transitProvider: '<string>',
flightCode: '<string>',
transitStatusReason: '<string>',
venueGatesOpenDate: '2023-11-07T05:31:56Z',
venueEntranceDoor: '<string>',
performerNames: ['<string>'],
venueDoorsOpenDate: '2023-11-07T05:31:56Z',
transitStatus: '<string>',
venueRegionName: '<string>',
departureStationName: '<string>',
homeTeamName: '<string>',
destinationStationName: '<string>',
venueCloseDate: '2023-11-07T05:31:56Z'
},
maxDistance: 2,
primaryFields: [{}],
barcodes: [{}],
sharing: '<string>',
beacons: [{}],
personalize: {},
appLaunchURL: '<string>',
messages: ['<string>'],
locations: [{latitude: 0, longitude: 0, altitude: 123, relevantText: '<string>'}]
})
};
fetch('https://api.platform.getstell.com/v1/programs/{programId}/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://api.platform.getstell.com/v1/programs/{programId}/templates/{templateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userInfo": {},
"backFields": [
{}
],
"associatedStoreIdentifiers": [
"<string>"
],
"description": "<string>",
"publicKey": "<string>",
"auxiliaryFields": [
{}
],
"enableGoogleSmartTap": true,
"colors": {
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"stripColor": "<string>",
"labelColor": "<string>"
},
"sharingProhibited": true,
"defaultLanguage": "<string>",
"supportedLanguages": [
"<string>"
],
"headerFields": [
{}
],
"expirationDate": "<string>",
"logoText": "<string>",
"organizationName": "<string>",
"relevantDates": [
{
"endDate": "<string>",
"relevantDate": "<string>",
"startDate": "<string>"
}
],
"secondaryFields": [
{}
],
"semanticTags": {
"eventLiveMessage": "<string>",
"leagueAbbreviation": "<string>",
"venuePhoneNumber": "<string>",
"priorityStatus": "<string>",
"tailgatingAllowed": true,
"seats": [
{
"seatIdentifier": "<string>",
"seatType": "<string>",
"seatDescription": "<string>",
"seatSection": "<string>",
"seatRow": "<string>",
"seatAisle": "<string>",
"seatSectionColor": "<string>",
"seatNumber": "<string>",
"seatLevel": "<string>"
}
],
"attendeeName": "<string>",
"leagueName": "<string>",
"securityScreening": "<string>",
"venueEntrance": "<string>",
"destinationGate": "<string>",
"playlistIDs": [
"<string>"
],
"eventName": "<string>",
"vehicleNumber": "<string>",
"airplay": [
{
"airPlayDeviceGroupToken": "<string>"
}
],
"homeTeamLocation": "<string>",
"silenceRequested": true,
"awayTeamAbbreviation": "<string>",
"departureAirportCode": "<string>",
"vehicleType": "<string>",
"departurePlatform": "<string>",
"awayTeamLocation": "<string>",
"destinationLocationDescription": "<string>",
"boardingSequenceNumber": "<string>",
"venueEntrancePortal": "<string>",
"additionalTicketAttributes": "<string>",
"destinationAirportName": "<string>",
"membershipProgramNumber": "<string>",
"venueOpenDate": "2023-11-07T05:31:56Z",
"admissionLevelAbbreviation": "<string>",
"currentBoardingDate": "2023-11-07T05:31:56Z",
"flightNumber": 123,
"artistIDs": [
"<string>"
],
"carNumber": "<string>",
"venueName": "<string>",
"confirmationNumber": "<string>",
"venueParkingLotsOpenDate": "2023-11-07T05:31:56Z",
"originalBoardingDate": "2023-11-07T05:31:56Z",
"awayTeamName": "<string>",
"albumIDs": [
"<string>"
],
"destinationPlatform": "<string>",
"homeTeamAbbreviation": "<string>",
"sportName": "<string>",
"departureAirportName": "<string>",
"wifiAccess": [
{
"password": "<string>",
"ssid": "<string>"
}
],
"eventStartDate": "2023-11-07T05:31:56Z",
"passengerName": {
"namePrefix": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"nickname": "<string>",
"nameSuffix": "<string>",
"middleName": "<string>",
"phoneticRepresentation": "<string>"
},
"destinationAirportCode": "<string>",
"vehicleName": "<string>",
"entranceDescription": "<string>",
"departureGate": "<string>",
"venueEntranceGate": "<string>",
"venueRoom": "<string>",
"venueFanZoneOpenDate": "2023-11-07T05:31:56Z",
"venueBoxOfficeOpenDate": "2023-11-07T05:31:56Z",
"departureLocationDescription": "<string>",
"originalDepartureDate": "2023-11-07T05:31:56Z",
"duration": 123,
"boardingGroup": "<string>",
"currentDepartureDate": "2023-11-07T05:31:56Z",
"destinationTerminal": "<string>",
"genre": "<string>",
"airlineCode": "<string>",
"currentArrivalDate": "2023-11-07T05:31:56Z",
"admissionLevel": "<string>",
"originalArrivalDate": "2023-11-07T05:31:56Z",
"eventEndDate": "2023-11-07T05:31:56Z",
"departureTerminal": "<string>",
"membershipProgramName": "<string>",
"transitProvider": "<string>",
"flightCode": "<string>",
"transitStatusReason": "<string>",
"venueGatesOpenDate": "2023-11-07T05:31:56Z",
"venueEntranceDoor": "<string>",
"performerNames": [
"<string>"
],
"venueDoorsOpenDate": "2023-11-07T05:31:56Z",
"transitStatus": "<string>",
"venueRegionName": "<string>",
"departureStationName": "<string>",
"homeTeamName": "<string>",
"destinationStationName": "<string>",
"venueCloseDate": "2023-11-07T05:31:56Z"
},
"maxDistance": 2,
"primaryFields": [
{}
],
"barcodes": [
{}
],
"sharing": "<string>",
"beacons": [
{}
],
"personalize": {},
"appLaunchURL": "<string>",
"messages": [
"<string>"
],
"locations": [
{
"latitude": 0,
"longitude": 0,
"altitude": 123,
"relevantText": "<string>"
}
]
}
'import requests
url = "https://api.platform.getstell.com/v1/programs/{programId}/templates/{templateId}"
payload = {
"userInfo": {},
"backFields": [{}],
"associatedStoreIdentifiers": ["<string>"],
"description": "<string>",
"publicKey": "<string>",
"auxiliaryFields": [{}],
"enableGoogleSmartTap": True,
"colors": {
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"stripColor": "<string>",
"labelColor": "<string>"
},
"sharingProhibited": True,
"defaultLanguage": "<string>",
"supportedLanguages": ["<string>"],
"headerFields": [{}],
"expirationDate": "<string>",
"logoText": "<string>",
"organizationName": "<string>",
"relevantDates": [
{
"endDate": "<string>",
"relevantDate": "<string>",
"startDate": "<string>"
}
],
"secondaryFields": [{}],
"semanticTags": {
"eventLiveMessage": "<string>",
"leagueAbbreviation": "<string>",
"venuePhoneNumber": "<string>",
"priorityStatus": "<string>",
"tailgatingAllowed": True,
"seats": [
{
"seatIdentifier": "<string>",
"seatType": "<string>",
"seatDescription": "<string>",
"seatSection": "<string>",
"seatRow": "<string>",
"seatAisle": "<string>",
"seatSectionColor": "<string>",
"seatNumber": "<string>",
"seatLevel": "<string>"
}
],
"attendeeName": "<string>",
"leagueName": "<string>",
"securityScreening": "<string>",
"venueEntrance": "<string>",
"destinationGate": "<string>",
"playlistIDs": ["<string>"],
"eventName": "<string>",
"vehicleNumber": "<string>",
"airplay": [{ "airPlayDeviceGroupToken": "<string>" }],
"homeTeamLocation": "<string>",
"silenceRequested": True,
"awayTeamAbbreviation": "<string>",
"departureAirportCode": "<string>",
"vehicleType": "<string>",
"departurePlatform": "<string>",
"awayTeamLocation": "<string>",
"destinationLocationDescription": "<string>",
"boardingSequenceNumber": "<string>",
"venueEntrancePortal": "<string>",
"additionalTicketAttributes": "<string>",
"destinationAirportName": "<string>",
"membershipProgramNumber": "<string>",
"venueOpenDate": "2023-11-07T05:31:56Z",
"admissionLevelAbbreviation": "<string>",
"currentBoardingDate": "2023-11-07T05:31:56Z",
"flightNumber": 123,
"artistIDs": ["<string>"],
"carNumber": "<string>",
"venueName": "<string>",
"confirmationNumber": "<string>",
"venueParkingLotsOpenDate": "2023-11-07T05:31:56Z",
"originalBoardingDate": "2023-11-07T05:31:56Z",
"awayTeamName": "<string>",
"albumIDs": ["<string>"],
"destinationPlatform": "<string>",
"homeTeamAbbreviation": "<string>",
"sportName": "<string>",
"departureAirportName": "<string>",
"wifiAccess": [
{
"password": "<string>",
"ssid": "<string>"
}
],
"eventStartDate": "2023-11-07T05:31:56Z",
"passengerName": {
"namePrefix": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"nickname": "<string>",
"nameSuffix": "<string>",
"middleName": "<string>",
"phoneticRepresentation": "<string>"
},
"destinationAirportCode": "<string>",
"vehicleName": "<string>",
"entranceDescription": "<string>",
"departureGate": "<string>",
"venueEntranceGate": "<string>",
"venueRoom": "<string>",
"venueFanZoneOpenDate": "2023-11-07T05:31:56Z",
"venueBoxOfficeOpenDate": "2023-11-07T05:31:56Z",
"departureLocationDescription": "<string>",
"originalDepartureDate": "2023-11-07T05:31:56Z",
"duration": 123,
"boardingGroup": "<string>",
"currentDepartureDate": "2023-11-07T05:31:56Z",
"destinationTerminal": "<string>",
"genre": "<string>",
"airlineCode": "<string>",
"currentArrivalDate": "2023-11-07T05:31:56Z",
"admissionLevel": "<string>",
"originalArrivalDate": "2023-11-07T05:31:56Z",
"eventEndDate": "2023-11-07T05:31:56Z",
"departureTerminal": "<string>",
"membershipProgramName": "<string>",
"transitProvider": "<string>",
"flightCode": "<string>",
"transitStatusReason": "<string>",
"venueGatesOpenDate": "2023-11-07T05:31:56Z",
"venueEntranceDoor": "<string>",
"performerNames": ["<string>"],
"venueDoorsOpenDate": "2023-11-07T05:31:56Z",
"transitStatus": "<string>",
"venueRegionName": "<string>",
"departureStationName": "<string>",
"homeTeamName": "<string>",
"destinationStationName": "<string>",
"venueCloseDate": "2023-11-07T05:31:56Z"
},
"maxDistance": 2,
"primaryFields": [{}],
"barcodes": [{}],
"sharing": "<string>",
"beacons": [{}],
"personalize": {},
"appLaunchURL": "<string>",
"messages": ["<string>"],
"locations": [
{
"latitude": 0,
"longitude": 0,
"altitude": 123,
"relevantText": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"userInfo": {},
"backFields": "<array>",
"associatedStoreIdentifiers": [
"<string>"
],
"description": "<string>",
"auxiliaryFields": "<array>",
"colors": {
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"stripColor": "<string>",
"labelColor": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"sharingProhibited": true,
"defaultLanguage": "<string>",
"supportedLanguages": [
"<string>"
],
"headerFields": "<array>",
"id": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"logoText": "<string>",
"organizationName": "<string>",
"secondaryFields": "<array>",
"relevantDates": [
{
"endDate": "2023-11-07T05:31:56Z",
"relevantDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
}
],
"semanticTags": {
"eventLiveMessage": "<string>",
"leagueAbbreviation": "<string>",
"venuePhoneNumber": "<string>",
"priorityStatus": "<string>",
"tailgatingAllowed": true,
"seats": [
{
"seatIdentifier": "<string>",
"seatType": "<string>",
"seatDescription": "<string>",
"seatSection": "<string>",
"seatRow": "<string>",
"seatAisle": "<string>",
"seatSectionColor": "<string>",
"seatNumber": "<string>",
"seatLevel": "<string>"
}
],
"attendeeName": "<string>",
"leagueName": "<string>",
"securityScreening": "<string>",
"venueEntrance": "<string>",
"destinationGate": "<string>",
"balance": {
"amount": "<string>",
"currencyCode": "<string>"
},
"playlistIDs": [
"<string>"
],
"eventName": "<string>",
"vehicleNumber": "<string>",
"airplay": [
{
"airPlayDeviceGroupToken": "<string>"
}
],
"homeTeamLocation": "<string>",
"silenceRequested": true,
"awayTeamAbbreviation": "<string>",
"departureAirportCode": "<string>",
"vehicleType": "<string>",
"departurePlatform": "<string>",
"awayTeamLocation": "<string>",
"destinationLocationDescription": "<string>",
"boardingSequenceNumber": "<string>",
"venueEntrancePortal": "<string>",
"additionalTicketAttributes": "<string>",
"destinationAirportName": "<string>",
"membershipProgramNumber": "<string>",
"venueOpenDate": "2023-11-07T05:31:56Z",
"admissionLevelAbbreviation": "<string>",
"currentBoardingDate": "2023-11-07T05:31:56Z",
"flightNumber": 123,
"artistIDs": [
"<string>"
],
"carNumber": "<string>",
"venueName": "<string>",
"eventStartDateInfo": {
"date": "<string>",
"ignoreTimeComponents": true,
"timeZone": "<string>"
},
"confirmationNumber": "<string>",
"venueParkingLotsOpenDate": "2023-11-07T05:31:56Z",
"originalBoardingDate": "2023-11-07T05:31:56Z",
"awayTeamName": "<string>",
"albumIDs": [
"<string>"
],
"destinationPlatform": "<string>",
"homeTeamAbbreviation": "<string>",
"sportName": "<string>",
"departureAirportName": "<string>",
"venueLocation": {
"latitude": 0,
"longitude": 0
},
"wifiAccess": [
{
"password": "<string>",
"ssid": "<string>"
}
],
"eventStartDate": "2023-11-07T05:31:56Z",
"passengerName": {
"namePrefix": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"nickname": "<string>",
"nameSuffix": "<string>",
"middleName": "<string>",
"phoneticRepresentation": "<string>"
},
"destinationAirportCode": "<string>",
"vehicleName": "<string>",
"entranceDescription": "<string>",
"departureGate": "<string>",
"totalPrice": {
"amount": "<string>",
"currencyCode": "<string>"
},
"venueEntranceGate": "<string>",
"venueRoom": "<string>",
"venueFanZoneOpenDate": "2023-11-07T05:31:56Z",
"venueBoxOfficeOpenDate": "2023-11-07T05:31:56Z",
"destinationLocation": {
"latitude": 0,
"longitude": 0
},
"departureLocationDescription": "<string>",
"originalDepartureDate": "2023-11-07T05:31:56Z",
"duration": 123,
"boardingGroup": "<string>",
"currentDepartureDate": "2023-11-07T05:31:56Z",
"destinationTerminal": "<string>",
"genre": "<string>",
"airlineCode": "<string>",
"currentArrivalDate": "2023-11-07T05:31:56Z",
"admissionLevel": "<string>",
"originalArrivalDate": "2023-11-07T05:31:56Z",
"eventEndDate": "2023-11-07T05:31:56Z",
"departureTerminal": "<string>",
"membershipProgramName": "<string>",
"transitProvider": "<string>",
"departureLocation": {
"latitude": 0,
"longitude": 0
},
"flightCode": "<string>",
"transitStatusReason": "<string>",
"venueGatesOpenDate": "2023-11-07T05:31:56Z",
"venueEntranceDoor": "<string>",
"performerNames": [
"<string>"
],
"venueDoorsOpenDate": "2023-11-07T05:31:56Z",
"transitStatus": "<string>",
"venueRegionName": "<string>",
"departureStationName": "<string>",
"homeTeamName": "<string>",
"destinationStationName": "<string>",
"venueCloseDate": "2023-11-07T05:31:56Z"
},
"primaryFields": "<array>",
"maxDistance": 123,
"barcodes": [
{
"altText": "<string>",
"messageEncoding": "<string>",
"message": "<string>"
}
],
"sharing": "<string>",
"beacons": [
{
"relevantText": "<string>",
"major": 123,
"minor": 123,
"uuid": "<string>"
}
],
"personalize": {},
"appLaunchURL": "<string>",
"locations": [
{
"relevantText": "<string>",
"latitude": 123,
"maxDistance": 123,
"longitude": 123
}
],
"programId": "<string>"
},
"requestId": "<string>"
}{
"requestId": "<string>",
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request parameters",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "FORBIDDEN",
"message": "Access denied to this resource",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred",
"details": {}
}
}Pass Templates
Update program pass template
Update design configuration or settings for an existing template within a program.
PATCH
https://api.platform.getstell.com
/
v1
/
programs
/
{programId}
/
templates
/
{templateId}
Update program pass template
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userInfo: {},
backFields: [{}],
associatedStoreIdentifiers: ['<string>'],
description: '<string>',
publicKey: '<string>',
auxiliaryFields: [{}],
enableGoogleSmartTap: true,
colors: {
backgroundColor: '<string>',
foregroundColor: '<string>',
stripColor: '<string>',
labelColor: '<string>'
},
sharingProhibited: true,
defaultLanguage: '<string>',
supportedLanguages: ['<string>'],
headerFields: [{}],
expirationDate: '<string>',
logoText: '<string>',
organizationName: '<string>',
relevantDates: [{endDate: '<string>', relevantDate: '<string>', startDate: '<string>'}],
secondaryFields: [{}],
semanticTags: {
eventLiveMessage: '<string>',
leagueAbbreviation: '<string>',
venuePhoneNumber: '<string>',
priorityStatus: '<string>',
tailgatingAllowed: true,
seats: [
{
seatIdentifier: '<string>',
seatType: '<string>',
seatDescription: '<string>',
seatSection: '<string>',
seatRow: '<string>',
seatAisle: '<string>',
seatSectionColor: '<string>',
seatNumber: '<string>',
seatLevel: '<string>'
}
],
attendeeName: '<string>',
leagueName: '<string>',
securityScreening: '<string>',
venueEntrance: '<string>',
destinationGate: '<string>',
playlistIDs: ['<string>'],
eventName: '<string>',
vehicleNumber: '<string>',
airplay: [{airPlayDeviceGroupToken: '<string>'}],
homeTeamLocation: '<string>',
silenceRequested: true,
awayTeamAbbreviation: '<string>',
departureAirportCode: '<string>',
vehicleType: '<string>',
departurePlatform: '<string>',
awayTeamLocation: '<string>',
destinationLocationDescription: '<string>',
boardingSequenceNumber: '<string>',
venueEntrancePortal: '<string>',
additionalTicketAttributes: '<string>',
destinationAirportName: '<string>',
membershipProgramNumber: '<string>',
venueOpenDate: '2023-11-07T05:31:56Z',
admissionLevelAbbreviation: '<string>',
currentBoardingDate: '2023-11-07T05:31:56Z',
flightNumber: 123,
artistIDs: ['<string>'],
carNumber: '<string>',
venueName: '<string>',
confirmationNumber: '<string>',
venueParkingLotsOpenDate: '2023-11-07T05:31:56Z',
originalBoardingDate: '2023-11-07T05:31:56Z',
awayTeamName: '<string>',
albumIDs: ['<string>'],
destinationPlatform: '<string>',
homeTeamAbbreviation: '<string>',
sportName: '<string>',
departureAirportName: '<string>',
wifiAccess: [{password: '<string>', ssid: '<string>'}],
eventStartDate: '2023-11-07T05:31:56Z',
passengerName: {
namePrefix: '<string>',
familyName: '<string>',
givenName: '<string>',
nickname: '<string>',
nameSuffix: '<string>',
middleName: '<string>',
phoneticRepresentation: '<string>'
},
destinationAirportCode: '<string>',
vehicleName: '<string>',
entranceDescription: '<string>',
departureGate: '<string>',
venueEntranceGate: '<string>',
venueRoom: '<string>',
venueFanZoneOpenDate: '2023-11-07T05:31:56Z',
venueBoxOfficeOpenDate: '2023-11-07T05:31:56Z',
departureLocationDescription: '<string>',
originalDepartureDate: '2023-11-07T05:31:56Z',
duration: 123,
boardingGroup: '<string>',
currentDepartureDate: '2023-11-07T05:31:56Z',
destinationTerminal: '<string>',
genre: '<string>',
airlineCode: '<string>',
currentArrivalDate: '2023-11-07T05:31:56Z',
admissionLevel: '<string>',
originalArrivalDate: '2023-11-07T05:31:56Z',
eventEndDate: '2023-11-07T05:31:56Z',
departureTerminal: '<string>',
membershipProgramName: '<string>',
transitProvider: '<string>',
flightCode: '<string>',
transitStatusReason: '<string>',
venueGatesOpenDate: '2023-11-07T05:31:56Z',
venueEntranceDoor: '<string>',
performerNames: ['<string>'],
venueDoorsOpenDate: '2023-11-07T05:31:56Z',
transitStatus: '<string>',
venueRegionName: '<string>',
departureStationName: '<string>',
homeTeamName: '<string>',
destinationStationName: '<string>',
venueCloseDate: '2023-11-07T05:31:56Z'
},
maxDistance: 2,
primaryFields: [{}],
barcodes: [{}],
sharing: '<string>',
beacons: [{}],
personalize: {},
appLaunchURL: '<string>',
messages: ['<string>'],
locations: [{latitude: 0, longitude: 0, altitude: 123, relevantText: '<string>'}]
})
};
fetch('https://api.platform.getstell.com/v1/programs/{programId}/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://api.platform.getstell.com/v1/programs/{programId}/templates/{templateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userInfo": {},
"backFields": [
{}
],
"associatedStoreIdentifiers": [
"<string>"
],
"description": "<string>",
"publicKey": "<string>",
"auxiliaryFields": [
{}
],
"enableGoogleSmartTap": true,
"colors": {
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"stripColor": "<string>",
"labelColor": "<string>"
},
"sharingProhibited": true,
"defaultLanguage": "<string>",
"supportedLanguages": [
"<string>"
],
"headerFields": [
{}
],
"expirationDate": "<string>",
"logoText": "<string>",
"organizationName": "<string>",
"relevantDates": [
{
"endDate": "<string>",
"relevantDate": "<string>",
"startDate": "<string>"
}
],
"secondaryFields": [
{}
],
"semanticTags": {
"eventLiveMessage": "<string>",
"leagueAbbreviation": "<string>",
"venuePhoneNumber": "<string>",
"priorityStatus": "<string>",
"tailgatingAllowed": true,
"seats": [
{
"seatIdentifier": "<string>",
"seatType": "<string>",
"seatDescription": "<string>",
"seatSection": "<string>",
"seatRow": "<string>",
"seatAisle": "<string>",
"seatSectionColor": "<string>",
"seatNumber": "<string>",
"seatLevel": "<string>"
}
],
"attendeeName": "<string>",
"leagueName": "<string>",
"securityScreening": "<string>",
"venueEntrance": "<string>",
"destinationGate": "<string>",
"playlistIDs": [
"<string>"
],
"eventName": "<string>",
"vehicleNumber": "<string>",
"airplay": [
{
"airPlayDeviceGroupToken": "<string>"
}
],
"homeTeamLocation": "<string>",
"silenceRequested": true,
"awayTeamAbbreviation": "<string>",
"departureAirportCode": "<string>",
"vehicleType": "<string>",
"departurePlatform": "<string>",
"awayTeamLocation": "<string>",
"destinationLocationDescription": "<string>",
"boardingSequenceNumber": "<string>",
"venueEntrancePortal": "<string>",
"additionalTicketAttributes": "<string>",
"destinationAirportName": "<string>",
"membershipProgramNumber": "<string>",
"venueOpenDate": "2023-11-07T05:31:56Z",
"admissionLevelAbbreviation": "<string>",
"currentBoardingDate": "2023-11-07T05:31:56Z",
"flightNumber": 123,
"artistIDs": [
"<string>"
],
"carNumber": "<string>",
"venueName": "<string>",
"confirmationNumber": "<string>",
"venueParkingLotsOpenDate": "2023-11-07T05:31:56Z",
"originalBoardingDate": "2023-11-07T05:31:56Z",
"awayTeamName": "<string>",
"albumIDs": [
"<string>"
],
"destinationPlatform": "<string>",
"homeTeamAbbreviation": "<string>",
"sportName": "<string>",
"departureAirportName": "<string>",
"wifiAccess": [
{
"password": "<string>",
"ssid": "<string>"
}
],
"eventStartDate": "2023-11-07T05:31:56Z",
"passengerName": {
"namePrefix": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"nickname": "<string>",
"nameSuffix": "<string>",
"middleName": "<string>",
"phoneticRepresentation": "<string>"
},
"destinationAirportCode": "<string>",
"vehicleName": "<string>",
"entranceDescription": "<string>",
"departureGate": "<string>",
"venueEntranceGate": "<string>",
"venueRoom": "<string>",
"venueFanZoneOpenDate": "2023-11-07T05:31:56Z",
"venueBoxOfficeOpenDate": "2023-11-07T05:31:56Z",
"departureLocationDescription": "<string>",
"originalDepartureDate": "2023-11-07T05:31:56Z",
"duration": 123,
"boardingGroup": "<string>",
"currentDepartureDate": "2023-11-07T05:31:56Z",
"destinationTerminal": "<string>",
"genre": "<string>",
"airlineCode": "<string>",
"currentArrivalDate": "2023-11-07T05:31:56Z",
"admissionLevel": "<string>",
"originalArrivalDate": "2023-11-07T05:31:56Z",
"eventEndDate": "2023-11-07T05:31:56Z",
"departureTerminal": "<string>",
"membershipProgramName": "<string>",
"transitProvider": "<string>",
"flightCode": "<string>",
"transitStatusReason": "<string>",
"venueGatesOpenDate": "2023-11-07T05:31:56Z",
"venueEntranceDoor": "<string>",
"performerNames": [
"<string>"
],
"venueDoorsOpenDate": "2023-11-07T05:31:56Z",
"transitStatus": "<string>",
"venueRegionName": "<string>",
"departureStationName": "<string>",
"homeTeamName": "<string>",
"destinationStationName": "<string>",
"venueCloseDate": "2023-11-07T05:31:56Z"
},
"maxDistance": 2,
"primaryFields": [
{}
],
"barcodes": [
{}
],
"sharing": "<string>",
"beacons": [
{}
],
"personalize": {},
"appLaunchURL": "<string>",
"messages": [
"<string>"
],
"locations": [
{
"latitude": 0,
"longitude": 0,
"altitude": 123,
"relevantText": "<string>"
}
]
}
'import requests
url = "https://api.platform.getstell.com/v1/programs/{programId}/templates/{templateId}"
payload = {
"userInfo": {},
"backFields": [{}],
"associatedStoreIdentifiers": ["<string>"],
"description": "<string>",
"publicKey": "<string>",
"auxiliaryFields": [{}],
"enableGoogleSmartTap": True,
"colors": {
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"stripColor": "<string>",
"labelColor": "<string>"
},
"sharingProhibited": True,
"defaultLanguage": "<string>",
"supportedLanguages": ["<string>"],
"headerFields": [{}],
"expirationDate": "<string>",
"logoText": "<string>",
"organizationName": "<string>",
"relevantDates": [
{
"endDate": "<string>",
"relevantDate": "<string>",
"startDate": "<string>"
}
],
"secondaryFields": [{}],
"semanticTags": {
"eventLiveMessage": "<string>",
"leagueAbbreviation": "<string>",
"venuePhoneNumber": "<string>",
"priorityStatus": "<string>",
"tailgatingAllowed": True,
"seats": [
{
"seatIdentifier": "<string>",
"seatType": "<string>",
"seatDescription": "<string>",
"seatSection": "<string>",
"seatRow": "<string>",
"seatAisle": "<string>",
"seatSectionColor": "<string>",
"seatNumber": "<string>",
"seatLevel": "<string>"
}
],
"attendeeName": "<string>",
"leagueName": "<string>",
"securityScreening": "<string>",
"venueEntrance": "<string>",
"destinationGate": "<string>",
"playlistIDs": ["<string>"],
"eventName": "<string>",
"vehicleNumber": "<string>",
"airplay": [{ "airPlayDeviceGroupToken": "<string>" }],
"homeTeamLocation": "<string>",
"silenceRequested": True,
"awayTeamAbbreviation": "<string>",
"departureAirportCode": "<string>",
"vehicleType": "<string>",
"departurePlatform": "<string>",
"awayTeamLocation": "<string>",
"destinationLocationDescription": "<string>",
"boardingSequenceNumber": "<string>",
"venueEntrancePortal": "<string>",
"additionalTicketAttributes": "<string>",
"destinationAirportName": "<string>",
"membershipProgramNumber": "<string>",
"venueOpenDate": "2023-11-07T05:31:56Z",
"admissionLevelAbbreviation": "<string>",
"currentBoardingDate": "2023-11-07T05:31:56Z",
"flightNumber": 123,
"artistIDs": ["<string>"],
"carNumber": "<string>",
"venueName": "<string>",
"confirmationNumber": "<string>",
"venueParkingLotsOpenDate": "2023-11-07T05:31:56Z",
"originalBoardingDate": "2023-11-07T05:31:56Z",
"awayTeamName": "<string>",
"albumIDs": ["<string>"],
"destinationPlatform": "<string>",
"homeTeamAbbreviation": "<string>",
"sportName": "<string>",
"departureAirportName": "<string>",
"wifiAccess": [
{
"password": "<string>",
"ssid": "<string>"
}
],
"eventStartDate": "2023-11-07T05:31:56Z",
"passengerName": {
"namePrefix": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"nickname": "<string>",
"nameSuffix": "<string>",
"middleName": "<string>",
"phoneticRepresentation": "<string>"
},
"destinationAirportCode": "<string>",
"vehicleName": "<string>",
"entranceDescription": "<string>",
"departureGate": "<string>",
"venueEntranceGate": "<string>",
"venueRoom": "<string>",
"venueFanZoneOpenDate": "2023-11-07T05:31:56Z",
"venueBoxOfficeOpenDate": "2023-11-07T05:31:56Z",
"departureLocationDescription": "<string>",
"originalDepartureDate": "2023-11-07T05:31:56Z",
"duration": 123,
"boardingGroup": "<string>",
"currentDepartureDate": "2023-11-07T05:31:56Z",
"destinationTerminal": "<string>",
"genre": "<string>",
"airlineCode": "<string>",
"currentArrivalDate": "2023-11-07T05:31:56Z",
"admissionLevel": "<string>",
"originalArrivalDate": "2023-11-07T05:31:56Z",
"eventEndDate": "2023-11-07T05:31:56Z",
"departureTerminal": "<string>",
"membershipProgramName": "<string>",
"transitProvider": "<string>",
"flightCode": "<string>",
"transitStatusReason": "<string>",
"venueGatesOpenDate": "2023-11-07T05:31:56Z",
"venueEntranceDoor": "<string>",
"performerNames": ["<string>"],
"venueDoorsOpenDate": "2023-11-07T05:31:56Z",
"transitStatus": "<string>",
"venueRegionName": "<string>",
"departureStationName": "<string>",
"homeTeamName": "<string>",
"destinationStationName": "<string>",
"venueCloseDate": "2023-11-07T05:31:56Z"
},
"maxDistance": 2,
"primaryFields": [{}],
"barcodes": [{}],
"sharing": "<string>",
"beacons": [{}],
"personalize": {},
"appLaunchURL": "<string>",
"messages": ["<string>"],
"locations": [
{
"latitude": 0,
"longitude": 0,
"altitude": 123,
"relevantText": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"userInfo": {},
"backFields": "<array>",
"associatedStoreIdentifiers": [
"<string>"
],
"description": "<string>",
"auxiliaryFields": "<array>",
"colors": {
"backgroundColor": "<string>",
"foregroundColor": "<string>",
"stripColor": "<string>",
"labelColor": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"sharingProhibited": true,
"defaultLanguage": "<string>",
"supportedLanguages": [
"<string>"
],
"headerFields": "<array>",
"id": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"logoText": "<string>",
"organizationName": "<string>",
"secondaryFields": "<array>",
"relevantDates": [
{
"endDate": "2023-11-07T05:31:56Z",
"relevantDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
}
],
"semanticTags": {
"eventLiveMessage": "<string>",
"leagueAbbreviation": "<string>",
"venuePhoneNumber": "<string>",
"priorityStatus": "<string>",
"tailgatingAllowed": true,
"seats": [
{
"seatIdentifier": "<string>",
"seatType": "<string>",
"seatDescription": "<string>",
"seatSection": "<string>",
"seatRow": "<string>",
"seatAisle": "<string>",
"seatSectionColor": "<string>",
"seatNumber": "<string>",
"seatLevel": "<string>"
}
],
"attendeeName": "<string>",
"leagueName": "<string>",
"securityScreening": "<string>",
"venueEntrance": "<string>",
"destinationGate": "<string>",
"balance": {
"amount": "<string>",
"currencyCode": "<string>"
},
"playlistIDs": [
"<string>"
],
"eventName": "<string>",
"vehicleNumber": "<string>",
"airplay": [
{
"airPlayDeviceGroupToken": "<string>"
}
],
"homeTeamLocation": "<string>",
"silenceRequested": true,
"awayTeamAbbreviation": "<string>",
"departureAirportCode": "<string>",
"vehicleType": "<string>",
"departurePlatform": "<string>",
"awayTeamLocation": "<string>",
"destinationLocationDescription": "<string>",
"boardingSequenceNumber": "<string>",
"venueEntrancePortal": "<string>",
"additionalTicketAttributes": "<string>",
"destinationAirportName": "<string>",
"membershipProgramNumber": "<string>",
"venueOpenDate": "2023-11-07T05:31:56Z",
"admissionLevelAbbreviation": "<string>",
"currentBoardingDate": "2023-11-07T05:31:56Z",
"flightNumber": 123,
"artistIDs": [
"<string>"
],
"carNumber": "<string>",
"venueName": "<string>",
"eventStartDateInfo": {
"date": "<string>",
"ignoreTimeComponents": true,
"timeZone": "<string>"
},
"confirmationNumber": "<string>",
"venueParkingLotsOpenDate": "2023-11-07T05:31:56Z",
"originalBoardingDate": "2023-11-07T05:31:56Z",
"awayTeamName": "<string>",
"albumIDs": [
"<string>"
],
"destinationPlatform": "<string>",
"homeTeamAbbreviation": "<string>",
"sportName": "<string>",
"departureAirportName": "<string>",
"venueLocation": {
"latitude": 0,
"longitude": 0
},
"wifiAccess": [
{
"password": "<string>",
"ssid": "<string>"
}
],
"eventStartDate": "2023-11-07T05:31:56Z",
"passengerName": {
"namePrefix": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"nickname": "<string>",
"nameSuffix": "<string>",
"middleName": "<string>",
"phoneticRepresentation": "<string>"
},
"destinationAirportCode": "<string>",
"vehicleName": "<string>",
"entranceDescription": "<string>",
"departureGate": "<string>",
"totalPrice": {
"amount": "<string>",
"currencyCode": "<string>"
},
"venueEntranceGate": "<string>",
"venueRoom": "<string>",
"venueFanZoneOpenDate": "2023-11-07T05:31:56Z",
"venueBoxOfficeOpenDate": "2023-11-07T05:31:56Z",
"destinationLocation": {
"latitude": 0,
"longitude": 0
},
"departureLocationDescription": "<string>",
"originalDepartureDate": "2023-11-07T05:31:56Z",
"duration": 123,
"boardingGroup": "<string>",
"currentDepartureDate": "2023-11-07T05:31:56Z",
"destinationTerminal": "<string>",
"genre": "<string>",
"airlineCode": "<string>",
"currentArrivalDate": "2023-11-07T05:31:56Z",
"admissionLevel": "<string>",
"originalArrivalDate": "2023-11-07T05:31:56Z",
"eventEndDate": "2023-11-07T05:31:56Z",
"departureTerminal": "<string>",
"membershipProgramName": "<string>",
"transitProvider": "<string>",
"departureLocation": {
"latitude": 0,
"longitude": 0
},
"flightCode": "<string>",
"transitStatusReason": "<string>",
"venueGatesOpenDate": "2023-11-07T05:31:56Z",
"venueEntranceDoor": "<string>",
"performerNames": [
"<string>"
],
"venueDoorsOpenDate": "2023-11-07T05:31:56Z",
"transitStatus": "<string>",
"venueRegionName": "<string>",
"departureStationName": "<string>",
"homeTeamName": "<string>",
"destinationStationName": "<string>",
"venueCloseDate": "2023-11-07T05:31:56Z"
},
"primaryFields": "<array>",
"maxDistance": 123,
"barcodes": [
{
"altText": "<string>",
"messageEncoding": "<string>",
"message": "<string>"
}
],
"sharing": "<string>",
"beacons": [
{
"relevantText": "<string>",
"major": 123,
"minor": 123,
"uuid": "<string>"
}
],
"personalize": {},
"appLaunchURL": "<string>",
"locations": [
{
"relevantText": "<string>",
"latitude": 123,
"maxDistance": 123,
"longitude": 123
}
],
"programId": "<string>"
},
"requestId": "<string>"
}{
"requestId": "<string>",
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request parameters",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "FORBIDDEN",
"message": "Access denied to this resource",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"details": {}
}
}{
"requestId": "<string>",
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred",
"details": {}
}
}Authorizations
API key authentication. Include your API key as a Bearer token.
Example: Bearer sk_prod_xxxxxx
Get your API key from the Stell Dashboard.
Body
application/json
Request body for updating an existing pass template. All fields are optional — only include fields you want to change.
Custom user information stored with the pass
Fields displayed on the back of the pass
Associated App Store app identifiers
App Store identifier
Pass template description
Maximum string length:
500Public key for pass authentication
Auxiliary fields displayed in a supporting role
Enable Google Smart Tap for NFC interactions
Color scheme configuration for the pass
Show child attributes
Show child attributes
Whether pass sharing is prohibited
Default language code for the pass
Pattern:
^[a-z]{2}(-[A-Z]{2})?$Visual style of the pass template
Available options:
GENERIC_CARD, COUPON, EVENT_TICKET, BOARDING_PASS, STORE_CARD Supported language codes for localization
IETF BCP 47 language tag
Pattern:
^[a-z]{2}(-[A-Z]{2})?$Header fields displayed at the top of the pass
Pass expiration date in ISO 8601 format
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$Text displayed next to the logo
Maximum string length:
50Organization name displayed on the pass
Maximum string length:
100Lock-screen relevance entries. Each entry is either a single moment ({ relevantDate }) or an interval ({ startDate, endDate }), all in ISO 8601 format.
Show child attributes
Show child attributes
Secondary fields displayed below primary fields
Semantic tags for Apple Wallet passes: seating, flight, event and location details that Wallet and Siri use for suggestions. All fields are optional; send the ones that apply to your pass type.
Show child attributes
Show child attributes
Maximum distance in meters for location relevance
Required range:
x >= 1Primary fields displayed prominently on the pass
Barcode configurations for the pass
Pass sharing configuration
Beacon configurations for proximity notifications
Personalization configuration for the pass
URL to launch when pass is tapped
Custom messages for the pass
One custom message
Location-based notifications for the pass
Show child attributes
Show child attributes
Update template lifecycle status
Available options:
DRAFT, ACTIVE, INACTIVE, ARCHIVED ⌘I