Brands

🚧
The v5 API is deprecated
The v5 API is deprecated and will be sunset on June 30, 2027. Please follow the migration guide to move to the latest stable Omnisend API version.

Intro

Endpoint: https://api.omnisend.com/v5/brands/current

Retrieve information about the current brand or connect your store to Omnisend.

Connecting a Store

Use the POST endpoint to connect your e-commerce store to Omnisend. This endpoint enables the integration between your store and Omnisend for data synchronization.

Warning: The connect endpoint requires OAuth authentication. API key authentication is not supported for this operation.

Prerequisites

Before connecting, ensure:

The Omnisend tracking snippet is installed on your website
Your platform is supported (see table below)

Supported Platforms

Platform	Value
WooCommerce	woocommerce
WordPress	wordpress
Magento	magento
PrestaShop	prestashop
BigCartel	bigcartel
Wix Stores	wixStores
Ecwid	ecwid
nopCommerce	nopCommerce
Shoplazza	shoplazza
SureCart	sureCart
Genstore	genstore

Note: The platform value is case-sensitive. Use the exact value from the table above.

Connection Errors

Error	Description
Brand is already connected	The brand already has a connected store. Disconnect first before reconnecting.
Snippet not found	The Omnisend tracking code was not found on your website. Ensure it's properly installed.
Invalid platform	The platform value is not supported. Use one of the supported platform values.

Example: Get Brand Information

curl --request GET \
     --url https://api.omnisend.com/v5/brands/current \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
     --header 'accept: application/json'

Example: Connect Brand (OAuth only)

curl --request POST \
     --url https://api.omnisend.com/v5/brands/current \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "website": "https://www.example.com",
  "platform": "woocommerce",
  "version": "2",
  "currency": "USD"
}'

Field	Required	Description
website	Yes	Your store URL (must be a valid URL)
platform	Yes	Platform identifier (see supported platforms above)
version	Yes	Plugin/integration version (max 10 characters)
currency	No	Store currency in ISO 4217 format (e.g., USD, EUR)