Update a Pass Template

Updates the given 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.

POST/api/pass-template/{template-id}

Update a Pass Template

Updates the given pass template.

Path Parameters

Name
template-id
Type
string
(mandatory)
Description
The UUID of the template you want to update.

Example URL

Request URL

https://app.passcreator.com/api/pass-template/6d03a4a9-cf92-4e36-80b4-a8994546e2f7

Authorization

Name
Authorization
Type
string
(mandatory)
Description
HTTP Header containing your API key. Replace yourApiKeyHere with your actual API key.

Example HTTP Header

HTTP header

POST /api/pass-template/{template-id} HTTP/1.1
Host: app.passcreator.com
Authorization: yourApiKeyHere
Content-Type: application/json

Request Body

Name
name
Type
string
(mandatory)
Description
The name of the template.
Name
description
Type
string
(optional)
Description
If not specified the value from the original template will be used.
Name
organizationName
Type
string
(optional)
Description
If not specified the value from the original template will be used.
Name
foregroundColor
Type
string
(optional)
Description
A valid hex color.
Name
backgroundColor
Type
string
(optional)
Description
A valid hex color.
Name
labelColor
Type
string
(optional)
Description
A valid hex color.
Name
barcodeValue
Type
string
(optional)
Description
The barcode value.
Name
barcodeAlternativeText
Type
string
(optional)
Description
The text below the barcode.
Name
urlToLogo
Type
string
(optional)
Description
A valid URL to an image or a base64 encoded image.
Name
urlToBackground
Type
string
(optional)
Description
A valid URL to an image or a base64 encoded image.
Name
urlToIcon
Type
string
(optional)
Description
A valid URL to an image or a base64 encoded image.
Name
locations
Type
array<object>
(optional)
Description
An array of locations. Each location must at least include values for latitude and longitude.
Name
useDefaultImages
Type
boolean
(optional)
Description
Set this to true if the default Icon and Logo of the customer should be used for the copy of the template.

Example Request

Request body

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

Returned Values

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

Response Status Codes

Success Response

Status: 200 OK

Code Examples

Here you can find examples of how to call this endpoint using different programming languages and tools.

Replace 6d03a4a9-cf92-4e36-80b4-a8994546e2f7 with your actual template ID and yourApiKeyHere with your actual API key.

Request Examples

POST

/api/pass-template/{template-id}

curl -X POST "https://app.passcreator.com/api/pass-template/6d03a4a9-cf92-4e36-80b4-a8994546e2f7" \
  -H "Authorization: yourApiKeyHere" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Template copy",
    "description": "This is a description",
    "organizationName": "Dummy",
    "foregroundColor": "#000000",
    "backgroundColor": "#cccccc",
    "labelColor": "#ffffff"
  }'