Developer Documentation (API)

Update a Pass Template

This endpoint is deprecated and should no longer be used. Please use the new update template endpoint which allows you to manipulate every aspect of a template.

Required input parameters

HTTP Authorization Header that contains your API key
name – the name of the template
description (optional) – if not specified the value from the original template will be used
organizationName (optional) – if not specified the value from the original template will be used
foregroundColor (optional) – a valid hex color
backgroundColor (optional) – a valid hex color
labelColor (optional) – a valid hex color
barcodeValue (optional) – the barcode value
barcodeAlternativeText (optional) – the text below the barcode
urlToLogo (optional) – a valid URL to an image or a base64 encoded image
urlToBackground (optional) – a valid URL to an image or a base64 encoded image
urlToIcon (optional) – a valid URL to an image or a base64 encoded image
locations (optional) – an array of locations. Each location must at least include values for latitude and longitude
useDefaultImages (optional) – set this to true if the default Icon and Logo of the customer should be used for the copy of the template

Returned values

If the template has been updated successfully, Status 200 will be returned.

Example output:

{
	"name": "Template copy",
	"description": "This is a description",
	"organizationName": "Dummy",
	"foregroundColor": "#000000",
	"backgroundColor": "#cccccc",
	"labelColor": "#ffffff",
	"urlToLogo": "https://www.veski.leikbreytir.is/examplelogo.png",
	"urlToBackground": "https://www.veski.leikbreytir.is/examplebackground
	.png",
	"urlToIcon": "https://www.veski.leikbreytir.is/exampleicon.png",
	"locations": [{
		"latitude": 48.0933826,
		"longitude": 11.6286617,
		"relevantText": "Welcome to the show!",
		"altitude": 200,
		"maxDistance": 300
	}]
}