Skip to main content
PUT
Create or update a catalog product by your product ID

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

externalId
string
required

Your store's own product ID, without control characters. Sending the same ID again updates the product.

Required string length: 1 - 255
Example:

"8812345"

Body

application/json
title
string
required
Required string length: 1 - 500
price
string
required
Required string length: 1 - 50
Pattern: ^\d+(?:\.\d+)?$
Example:

"19.90"

currency
enum<string>
required
Available options:
USD,
EUR,
GBP,
CAD,
AUD,
NZD,
SEK,
NOK,
DKK,
CHF,
PLN,
CZK,
JPY
productUrl
string<uri>
required

The product page that product cards in emails link to.

Maximum string length: 2000
description

Plain text or the store's HTML description. HTML is stored as plain text.

Maximum string length: 20000
status
enum<string>
default:active

active products can appear in emails. hidden products stay in the catalog but out of emails. archived products leave the catalog.

Available options:
active,
hidden,
archived
compareAtPrice

The price before a discount, shown struck through.

Required string length: 1 - 50
Pattern: ^\d+(?:\.\d+)?$
imageUrl

The product's main image. Segmentflow shows it from this URL and copies it only when an email needs its own copy.

Maximum string length: 2000
category
Required string length: 1 - 200
tags
string[]
Maximum array length: 50
Required string length: 1 - 100
sku
Required string length: 1 - 200

Response

Default Response

success
boolean
required
outcome
enum<string>
required
Available options:
created,
updated
data
object
required

Unified API catalog product response without organization-internal fields.