Skip to main content
POST
Generate Segments

Authorizations

api_key
string
header
required

Body

application/json

Segment generation input with source materials

segments
object[]
required

Array of segment generation requests - each object generates one market segment

Minimum array length: 1
Example:
primaryOfferingOId
string

Primary Offering to use as context when generating segments. If not provided, the primary company attached to the Workspace will be used.

Example:

"o_123456"

linkingStrategy
object

Strategy for linking generated segments to offerings (products/services)

brandVoiceOId
string

Brand voice oId to apply to generated segments

Example:

"bv_123456"

Response

Segments generated successfully

_metadata
object
required
data
object[]
required