Skip to main content
POST
Create Product
Creates a new catalog product in your workspace.

Product code uniqueness

The code property must be unique across all products in your workspace. Submitting a request with an existing product code will result in an HTTP 409 Conflict error.

Required permissions

Requires an API key with the crm:write scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Body

application/json
name
string
required
Example:

"Annual Enterprise License"

code
string
required

Unique product code/SKU in workspace

Example:

"LIC-ENT-001"

unit_price
number
required
Example:

1200

category
string
Example:

"Software Subscriptions"

unit
string
Example:

"seat"

custom_fields
object
Example:

Response

Product created successfully

Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation) endpoints

success
boolean
required
Example:

true

data
object
required

The created or updated entity

error
null
required
Example:

null