> ## Documentation Index
> Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API changelog

> Behaviour changes to the SegmentFlow.ai API.

**2026-11-21**

Other store platforms

### Connect a store on another platform

[Connect another store platform](https://segmentflow.ai/docs/connect-other-platforms.md) shows how to send a Shopware, Salla or other store's products and orders through the catalog products and order transactions endpoints, directly or through n8n or Make, with tested mappings of a Shopware and a Salla order webhook. API Keys created in **Settings → API Keys** can now have the `catalog-products:write` and `catalog-products:read` scopes the connection needs.

**2026-11-21**

Unmatched order items

### See which order items match no catalog product

`GET /api/v1/catalog-products/unmatched-order-items` returns, per source, how many items in the last 90 days of orders matched no catalog product, with the product IDs or SKUs most of them named, as last counted overnight. It uses API Keys with `catalog-products:read`. See [Catalog products](https://segmentflow.ai/docs/catalog-products.md#find-order-items-that-match-no-product).

**2026-11-21**

Order transactions

### Send orders with their products, and refunds

`POST /api/v1/events/order-transactions` accepts the `order-transaction.v2` contract: a paid order with its line items, or a refund that names its order and the refunded items or amount. The `source` and `orderId` identify the order, so sending them again updates it. Past orders sent with `historical: true` never start a Journey. `POST /api/v1/events/order-transactions/batch` takes up to 100 at a time. Both use API Keys with `events:write`. Orders sent through `events.track` keep working as before. See [Order transactions](https://segmentflow.ai/docs/order-transactions.md).

**2026-11-16**

Privacy requests

### Answer GDPR access requests from the API

`/api/v1/privacy-requests` requests a Profile data export by `profileId` or `email`, lists access and erasure requests, retrieves one request's status, and issues a short-lived download link for a ready export. It needs the new `privacy-requests:read` and `privacy-requests:write` scopes, and the API Key's creator must be an owner or admin. The endpoints keep working while the subscription has lapsed. See [Privacy requests](https://segmentflow.ai/docs/privacy-requests.md).

**2026-10-30**

Subscription groups

### Manage subscription groups from the API

`/api/v1/subscription-groups` lists, creates, retrieves, updates and deletes subscription groups. It needs the new `subscription-groups:read` and `subscription-groups:write` scopes, so create a new API Key with those scopes to use it.

### Deleting a group that holds consent records is refused

Deleting a subscription group now returns `409` while the group holds anyone's subscribe or unsubscribe choice, because deleting it would erase those choices. Set `isActive` to `false` to hide the group instead, which pauses it for new sends.

**2026-10-10**

Brand Kit and email validation

### Brand Kit writes refuse unsafe fonts, colours and Google Fonts URLs

`POST /brand-kit` and `PUT /brand-kit/{brandId}` now return `400 VALIDATION_ERROR` when a Brand Kit value could inject CSS or markup into a rendered email. Requests that previously succeeded can now be refused:

* **Colours** (`colors`, `colorsPalette.*`, `components.*.background`, `components.*.textColor`, `components.*.borderColor`, `icons.primaryColor`) must be a hex colour (`#rgb`, `#rgba`, `#rrggbb` or `#rrggbbaa`) or `transparent`.
* **Fonts** (`fonts`, `typography.fontStacks.*`, `emailFonts.*.family`, `emailFonts.*.fontStack`) must be a family name or a comma-separated font stack made of letters, digits, spaces, quotes, `_`, `.` and `-`.
* **`emailFonts.*.googleFontsUrl`** must be an `https://fonts.googleapis.com/` URL.

Each issue in `details.issues` names the refused field in `path`, for example `["brandKit", "colors", 0]`. Reading a Brand Kit saved before this change still works; unsafe stored values are left out when an email renders.

### Request validation errors name the field

Every `400 VALIDATION_ERROR` caused by request validation now fills `details.issues[].path` with the path of the invalid field. It was previously an empty string.

### Raw-HTML email elements are refused

Email definitions may no longer contain the `Raw`, `Font`, `Markdown` or `Conditional` elements. Saving a Template or email that uses one is refused with a validation error, and the renderer ignores them.

### Templates refuse unsafe links

`POST /v1/templates` and `PUT /v1/templates/{id}` now return `400 BAD_REQUEST` when a link in `definition.body` or `definition.defaultBody` uses a scheme an email can never send, such as `javascript:`, `data:`, `vbscript:` or `file:`. Before, such a Template was saved but could then never be previewed, test-sent or sent.

`details.reason` is `unsafe_destination`, and `details.field` names the link, for example `definition.defaultBody.content[0].content[0].marks[0].attrs.href`. Links that use `http`, `https`, `mailto` or `tel`, and personalized links such as `{{ shop_url }}`, are unchanged.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.