latestOpenAPI 3.0.32026-08-23640164.5 KB

1d888a894943

Workspaces

Create a new workspace product used as context for AI-generated outreach.

post/public/v1/workspace-products

Request body

workspaceIdstring required

ID of the workspace to create the product in.

namestring required

Product or company name.

descriptionstring required

Short description of what you offer.

painPointsstring[] required

Customer pain points your product addresses.

valuePropositionstring[] required

Key value propositions of your product.

proofPointsstring[] required

Social proof, case studies, or stats that back your claims.

ctastring

Optional. Call-to-action text used in outreach messages.

meetingLinkstring

Optional. Booking or meeting link to include in outreach.

outreachLanguagestring

Optional. Language for outreach messages (e.g. "English", "French"). Defaults to "English".

websiteUrlstring

Optional. Company / website URL (shown as "Company URL" in Studio).

productUrlstring

Optional. Product URL.

customerProfilestring

Optional. Ideal Customer Profile (ICP). Free text; Studio uses an "ALWAYS SCORE HIGH: / ALWAYS SCORE LOW:" convention inside this text to drive prospect scoring.

competitorsstring

Optional. Competitors, as free text.

extraMaterialsstring[]

Optional additional context or materials for AI message generation.

accessScope'OWNER' | 'WORKSPACE'

Who can use this product. OWNER = private to you; WORKSPACE = shared across the workspace (ADMIN/OWNER only).

Response

Default Response

statusCodenumber
statusboolean
messagestring