Skip to main content
POST
Create Segment

Authorizations

api_key
string
header
required

Body

application/json

Segment creation data

name
string
required

The name of the segment

Minimum string length: 1
Example:

"Enterprise Technology Companies"

description
string

The description of the segment

Example:

"Companies with 500+ employees in the technology sector"

additionalProperties
object

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

Example:
primaryOfferingOId
string

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

Example:

"o_123456"

linkingStrategy
object

Strategy for linking this segment to offerings (products/services)

Response

Segment created successfully

_metadata
object
required
data
object
required