Upsert a value added opportunity (Native Recommendation) for a pass.

put

https://api.trybadge.com/v0/passTemplates/{passTemplateId}/passes/{passId}/valueAddedOpportunities/{valueAddedOpportunityId}

Upsert a value added opportunity (Native Recommendation) for a pass. A maximum of 10 value added opportunities may be shown on a pass. If you would like to disable an opportunity, set the endAt date to a current or past date-time. See Google Wallet documentation for more details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

passTemplateId

uuid

required

passId

string

required

length ≥ 1

valueAddedOpportunityId

string

required

length ≥ 1

Unique identifier for the value added opportunity. We recommend reusing the same identifier across different passes for aggregate stat tracking.

Body Params

heading

string

required

length ≥ 1

Recommended 60 characters max to ensure this is not truncated on certain devices.

body

string

length ≥ 1

Recommended 50 characters max to ensure this is not truncated on certain devices.

linkUri

string

required

length ≥ 1

Web link or app deep link for the value added opportunity.

imageUri

string

length ≥ 1

Recommended ratio is 1:1.

sortIndex

integer

Lower sort index is shown first. If sort index is duplicated, more recently created value added opportunities are shown first.

startAt

date-time

If unspecified, the value added opportunity will be shown immediately.

endAt

date-time

If unspecified, the value added opportunity will be shown until it is removed.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Invalid input was received.