Skip to main content
POST
Create Product

Authorizations

api_key
string
header
required

Body

application/json

Product creation input

name
string
required

The external name of the product

Minimum string length: 1
Example:

"Marketing Automation Platform"

internalName
string

The internal name of the product

Example:

"MAP Product"

description
string

A description of the product

Example:

"A comprehensive marketing automation solution for businesses"

primaryUrl
string<uri>

The primary URL of the product

Example:

"https://www.product.com"

summary
string

A brief summary of the product

Example:

"Enterprise-grade marketing automation"

distinctCapabilities
string[]

What the product does at the functional level — outcome-oriented capabilities, not mechanisms (mechanisms live in keyFeatures).

Example:
keyFeatures
string[]

Specific, named, often branded components of the product worth highlighting — the 'how' behind the capabilities.

Example:
differentiatedValue
string[]

The differentiated value of the product

Example:
statusQuo
string[]

The current state or status quo that the product addresses

Example:
challengesAddressed
string[]

The challenges addressed by the offering

Example:
customerBenefits
string[]

The customer benefits of the offering

Example:
customFields
object[]

Custom fields for additional product information

additionalProperties
object

Workspace-defined additional property values for this product, keyed by property key.

Example:

Response

Product created successfully

_metadata
object
required
data
object
required