Skip to main content
PATCH
Update product

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

productDocId
string
required

A product document id, from GET /v1/products. Not your own productId.

Required string length: 1 - 200
Example:

"prd_1f60"

Body

application/json
name
string
Required string length: 1 - 120
description
string
Maximum string length: 2000
type
string

What kind of thing it is: saas, tshirt, course. Decides how it is pitched.

Maximum string length: 60

CTA target. Omit until you have a real one — a script never invents a link.

Maximum string length: 500
couponCode
string
Maximum string length: 60
status
enum<string>

Defaults to PRE-LAUNCH, never LIVE.

Available options:
LIVE,
PRE-LAUNCH,
INTERNAL
finance
boolean

A financial product that must carry the education-only disclosure. Claimed deliberately.

topicKeywords
string[]
Maximum array length: 30
Required string length: 1 - 80
bridgeLine
string

The in-script line that bridges into the pitch, in channel voice.

Maximum string length: 500

Response

Success.

success
boolean
required
product
object
required

Something a campaign can promote.

{key}
any