Update existing template

put

https://public-api.vibescm.com/companies/{company_key}/campaigns/wallet/{token}/passbook_templates/{passbook_template_id}

Make changes to a previously created iOS mobile wallet template using its passbook_template_id and the its associated campaign's SmartLink token.

Path Params

company_key

string

required

token

string

required

passbook_template_id

string

required

A unique identifier for your iOS wallet item template.

Important: If you are entering a real passbook_template_id, please note that using the "Try It" feature on the righthand console will send an actual API call to our system. This may result in a wallet template being updated.

Body Params

colors

object

Hash of the colors for background, foreground, and label text in hex format.

pass_description

string

A short description of the pass.

nfc_message

string

The message that is passed to an end user when they use NFC to wirelessly transfer data.

organization_name

string

A string that is usually the company name.

thank_you_url

string

A URL that we redirect to upon pass installation.

thank_you_message

string

A string that is displayed after a pass is installed. This doesn’t display if thank_you_url is set.

images

object

A hash with source_urls for images that are displayed on the wallet pass.

strip_images

array of objects

An array of dynamic strip images with a source_url. None of the images here will be used as the default strip images, and each one requires a unique image code.

strip_images

logo_text

string

A string that is displayed under the logo.

fields

object

A hash of text fields on the pass.

app_text

string

An id that references your app in the App Store.

sharing_prohibited

boolean

A Boolean value that will either allow or not allowing sharing of the pass.

barcode

array of objects

A hash for the the barcode displayed on a pass.

barcode

Headers

X-API-Version

string

Defaults to 1

Content-Type

string

required

Response

200Successful response