Booking Flow

Voucher Purchases

A VoucherPurchase is the purchase-side record of a voucher transaction — it captures the buyer, the recipient's contact details, the delivery method, and the gift-email content. The tradable VoucherCodes issued by the purchase are managed under the VoucherCodes tag.

post/shop/voucher-purchases/{voucherPurchaseId}/preview-email

Preview a voucher recipient email

actionPreviewVoucherPurchaseEmail

Renders the gift email that would be sent to a voucher recipient without dispatching it. Use this in operator UIs to show staff exactly what the recipient will see — including the rendered HTML body, sender, subject and CC/BCC list — before they commit to sending.

Pass recipient overrides in the body to preview against a different address (for example, a staff test inbox).

Path parameters

voucherPurchaseIdobject-idrequired
The ID of the VoucherPurchase.

Request body

recipient_emailemailoptional
Override the recipient email address. Defaults to the purchase's stored recipient email if omitted.
recipient_namestringoptional
Override the recipient name shown in the email greeting. Defaults to the purchase's stored recipient name if omitted.

Responses

200
A preview-ready transactional email built from the voucher purchase. Returned by both the preview and send endpoints.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/preview-email" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_email": "jane@example.com",
  "recipient_name": "Jane Jenkins"
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/preview-email', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "recipient_email": "jane@example.com",
    "recipient_name": "Jane Jenkins"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/preview-email",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "recipient_email": "jane@example.com",
        "recipient_name": "Jane Jenkins"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/preview-email', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'recipient_email' => 'jane@example.com',
            'recipient_name' => 'Jane Jenkins'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"recipient_email": "jane@example.com",
		"recipient_name": "Jane Jenkins",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/preview-email", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A preview-ready transactional email built from the voucher purchase. Returned by both the preview and send endpoints.

{
  "data": {
    "from": {
      "address": "jane@example.com",
      "name": "Jane Jenkins"
    },
    "to": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "cc": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "bcc": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "subject": "Your spa day voucher is here!",
    "html": "<html><body>Enjoy your day!</body></html>"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/voucher-purchases/{voucherPurchaseId}/send-email

Send a voucher recipient email

actionSendVoucherPurchaseEmail

Sends the gift email to the recipient on file for a voucher purchase. The rendered email is also returned in the response so operator UIs can preview what was sent.

Pass recipient overrides in the body to redirect the send — most commonly when the original delivery bounced or the customer supplied a corrected email address.

Path parameters

voucherPurchaseIdobject-idrequired
The ID of the VoucherPurchase.

Request body

recipient_emailemailoptional
Override the recipient email address. Defaults to the purchase's stored recipient email if omitted.
recipient_namestringoptional
Override the recipient name shown in the email greeting. Defaults to the purchase's stored recipient name if omitted.

Responses

200
A preview-ready transactional email built from the voucher purchase. Returned by both the preview and send endpoints.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/send-email" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_email": "jane@example.com",
  "recipient_name": "Jane Jenkins"
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/send-email', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "recipient_email": "jane@example.com",
    "recipient_name": "Jane Jenkins"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/send-email",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "recipient_email": "jane@example.com",
        "recipient_name": "Jane Jenkins"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/send-email', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'recipient_email' => 'jane@example.com',
            'recipient_name' => 'Jane Jenkins'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"recipient_email": "jane@example.com",
		"recipient_name": "Jane Jenkins",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/voucher-purchases/5dcb47800000000000000000/send-email", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A preview-ready transactional email built from the voucher purchase. Returned by both the preview and send endpoints.

{
  "data": {
    "from": {
      "address": "jane@example.com",
      "name": "Jane Jenkins"
    },
    "to": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "cc": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "bcc": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "subject": "Your spa day voucher is here!",
    "html": "<html><body>Enjoy your day!</body></html>"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}