Create new template

post

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

Create a new template for an Android wallet pass. Note that the wallet campaign must be created before you can add the wallet templates.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_key

string

required

token

string

required

Important: If you are entering a real wallet token, 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 new wallet template being created.

Body Params

title

string

A string to describe the wallet object.

provider

string

A string for the name of the merchant the loyalty card/offer is valid for.

issuer

string

A string that is usually the company for the wallet object.

loyalty_points

array of objects

A hash for the loyalty_points field.

loyalty_points

secondary_loyalty_points

array of objects

A hash for the secondary_loyalty_points field.

secondary_loyalty_points

hero_image

string

A string for the source_url of the hero image on the wallet_object.

logo

string

A string for the source_url of the image on the wallet_object.

strip_image

string

A string for the source_url of the strip_image on the wallet_object.

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

barcode

array of objects

A hash for describing the barcode on a wallet_object.

barcode

background_color

string

A hex value for the background color.

nfc_message

string

A string that will be sent on a smart tap.

account

array of objects

Offer campaigns only. A hash representing the account field on the wallet_object.

account

rewards_tier

array of objects

Offer campaigns only. A hash representing the rewards tier section of the wallet_object.

rewards_tier

subinfo

array of objects

An array of hashes for the subinfo section of the wallet_object.

subinfo

text_area

array of objects

An array of hashes for the text area of the wallet_object.

text_area

messages

array of objects

Offer campaign only. An array of hashes for the messages section of the wallet_object.

messages

links

array of objects

An array of hashes for the links section of the wallet_object.

links

Headers

X-API-Version

string

Defaults to 1

Response

200Successful response