From version 4.139 onwards
New Features and Enhancements from Version 4.139
With version 1.139, the Attendee API has been extended with several smaller enhancements to the response payload as well as a new use case. The payload now includes additional fields for identifying test transactions, capturing dynamic sale properties (UTMs / Affiliate links) from the purchase URL, and returning redeemed promotion codes. Furthermore, a new use case By Sale has been introduced, allowing consumers to retrieve all attendees associated with a specific sale transaction – for example, by using the orderId received via webhook (cart.checkedout). The following sections describe each change in detail.
Key Enhancements
1. New Payload Field: isTestSale
A new integer field isTestSale has been added to the payload across all use cases. It indicates whether the transaction is a test sale.
| Field | Type | Values | Description |
|---|---|---|---|
isTestSale | integer | 0 = real sale, 1 = test sale | Indicates whether the sale is a test transaction. If the field is not present in the payload, the sale is a real transaction (equivalent to 0). |
2. New Payload Object: saleProperties
UTM tracking parameters are now included in the Attendee API payload, enabling marketing attribution analysis directly from attendee data. This is not limited to UTM parameters – any query parameter present in the URL at time of sale will be captured and returned as a key-value pair. A new dynamic dictionary saleProperties has been added to the payload. It contains all query parameters that were passed in the URL during the purchase process.
| Field | Type | Description |
|---|---|---|
saleProperties | object (Dictionary ) | A dynamic key-value dictionary containing all query parameters captured from the sale URL. Both keys and values are completely dynamic and depend on the parameters present in the URL at time of purchase. If no query parameters were present, this field may be absent from the payload. |
Note: The keys are not restricted to standard UTM parameters (utm_source, utm_medium, etc.). Any arbitrary query parameter from the sale URL will be included, making this a fully flexible tracking mechanism.
3. New Payload Field: promotionCodes
Promotion codes redeemed during purchase are now returned as part of the attendee payload, on the ticket level.
| Field | Type | Description |
|---|---|---|
promotionCodes | string[] | Array of promotion codes applied to this ticket. If no promotion code was redeemed, this field will not be present in the payload at all (rather than returning an empty array). |
Note: The absence of the promotionCodes field indicates that no promotion code was used for this transaction. An empty array [] will not be returned.
4. New Use Case: Query by Sale
A new use case has been added that allows querying all attendees belonging to a specific sale transaction using the saleId. This is particularly useful when processing webhook events that provide an Order ID / saleId.
| Parameter | Type | Required | Description |
|---|---|---|---|
saleId | GUID | Yes | The unique identifier of the sale (e.g., received via webhook). |