Get a pass installation URL for a contact

Generate a wallet installation URL for a specific contact. The returned URL points to the pass installation page and encodes the pass, contact and organization identifiers as an encrypted token, so it can be shared with the contact (email, SMS, QR code, …) to add the pass to their Apple Wallet or Google Wallet.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

passIdstringRequiredformat: "uuid"

Pass ID. The unique identifier of the wallet pass for which to generate an installation URL.

contactIdlongRequired

The Brevo contact ID the installation URL is generated for.

Response

Installation URL generated successfully.

urlstringformat: "uri"

The wallet installation URL for the contact. Opening it lets the contact add the pass to their Apple Wallet or Google Wallet.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.wallet.getWalletPassInstallUrl("passId", 1);
8	}
9	main();