Issue Digital Pass

This action issues a digital pass to a specified party based on the configured digital pass template. The digital pass template can be of type Loyalty or Gift Card, and the available input parameters depend on the template type. You can trigger the issuance of a digital pass using its corresponding custom invocable action.

This action is available in API version 66.0 and later.

Supported REST HTTP Methods

URI: /services/data/v66.0/actions/custom/issueDigitalPass/actionName
<actionName> is the customer-defined name of the digital pass template. The action name is derived from the digital pass template. Spaces in the template name are URL-encoded (for example, replaced with %20).
Note
Formats: JSON
HTTP Methods: POST
Authentication: Authorization: Bearertoken

Inputs

Input parameters depend on the digital pass template type (Loyalty or Gift Card). At runtime, the system determines the template type and loads the corresponding parameters. These input parameters are applicable to both Loyalty and Gift Card digital passes.

Input	Details
partyId	Type string Description Required. The ID of the party (for example, Loyalty Program Member or Contact) to whom the digital pass is issued.
sourceRecordReferenceId	Type ID Description Required. Reference ID of the source record initiating the digital pass issuance (for example, a transaction, membership record, or promotion).

Inputs when the template type is Loyalty

These parameters are optional and are created by default when the loyalty digital pass template is activated. Users can modify these values as needed.

Input	Details
accountNameLabel	Type string Description The account name displayed on the loyalty digital pass.
accountIdLabel	Type string Description The account ID associated with the digital pass. Use this when issuing a digital pass for an account.
barcode	Type string Description The barcode value displayed on the loyalty digital pass.
rewardPoints	Type string Description The reward points balance displayed on the loyalty digital pass.
tier	Type string Description The tier of the loyalty program member displayed on the digital pass.
memberType	Type string Description The type of loyalty program member displayed on the digital pass.
expiryDate	Type date Description The expiry date of the loyalty digital pass.

Inputs when the template type is Gift Card

These parameters are optional and are created by default when the gift card digital pass template is activated. Users can modify these values as needed.

Input	Details
barcode	Type string Description The barcode value displayed on the gift card.
cardNumber	Type string Description The number displayed on the gift card.
value	Type string Description The monetary value of the gift card.
expiryDate	Type date Description The expiry date of the gift card.

Outputs

For Issue Digital Pass, the action returns a URL that can be used to create or add the digital pass to a supported wallet.

Output	Details
digitalPassUrl	Type List<String> Description The URL used to create the digital pass. This URL can be used to add the pass to a supported digital wallet.
errors	Type List<String> Description A list of error messages if the operation fails.
isSuccess	Type Boolean Description Indicates whether the operation is successful (`true`) or not (`false`).

Examples

This section has the sample request and response for issuing the digital pass.

Sample Resource

/services/data/v66.0/actions/custom/issueDigitalPass/Gift%20Card

Sample request

Here’s an example POST request for Gift Card Digital Pass.

1{
2  "inputs": [
3    {
4      "partyId": "0lMSG0000001Q8X2AU",
5      "sourceRecordReferenceId": "0lMSG0000001Q8X2AU",
6      "barcode": "GC-45879234",
7      "expiryDate": "2026-12-31"
8    }
9  ]
10}

Sample response

Here's a sample response for the Issue Digital Pass action. The output structure is the same for both template types. If the digital pass template is inactive or misconfigured, the action returns an error.

1{
2  "actionName": "Gift_Card",
3  "errors": null,
4  "isSuccess": true,
5  "outputValues": {
6    "digitalPassUrl": "https://wallet.example.com/pass/refresh/9f3a8c7b"
7  }
8}

Loyalty Management Developer Guide