HomeGuidesAPI Reference
Need Help?
API Reference
Need Help?

Replace product

put
https://api.omnisend.com/api/products/

Replace product by ID

Scopes:
products.write

Rate Limiting:
This endpoint is rate limited to 400 requests per minute.


Open Postman collection

Path Params
string
required

Product ID

Body Params

Product to replace

categoryIDs
array of strings
length ≤ 100
categoryIDs
string
string
required
string
length ≤ 1000

DefaultImageUrl is recommended if more than one image is needed. Other product images should be added to the Images array.

string
length ≤ 1000

Description is a short description of the product. It can be used in the email body.

string
required
length ≤ 100
images
array of strings
length ≤ 300
images
string
enum
required

Status can be inStock, outOfStock, or notAvailable. We recommended to keep it in sync with your shop product to ensure that Omnisend can avoid sending out-of-stock products to your customers.

Allowed:
tags
array of strings
length ≤ 100

Tags can be used to categorize products.

tags
string
required
length ≤ 255
string
length ≤ 100

Product type can be used to categorize products.

string
string
required
length ≤ 1000

Url should point to the product page on the website.

variants
array of objects
length between 1 and 500

Product variants are different versions of the same product. For example, a T-shirt can have different sizes and colors.

variants
string
length ≤ 1000

DefaultImageUrl is recommended if more than one image is needed. Other product images should be added to the Images array.

string
length ≤ 1000

Description is a short description of the product. It can be used in the email body.

string
required
length ≤ 100
images
array of strings
length ≤ 300
images
number
required
string
length ≤ 255
string
enum

Status can be inStock, outOfStock, or notAvailable. We recommended to keep it in sync with your shop product to ensure that Omnisend can avoid sending out-of-stock products to your customers.

Allowed:
number

StrikeThroughPrice is the price before the discount.

string
required
length ≤ 255
string
required
length ≤ 1000
string
length ≤ 100

Vendor is the manufacturer or the brand of the product.

Headers
string
required
Defaults to 2026-03-15

API version that specifies the response format and behaviour

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?