Skip to main content
POST
Update Segment

Authorizations

api_key
string
header
required

Body

application/json

Segment update input

oId
string
required

The ID of the segment to update

Minimum string length: 1
Example:

"sg_1234"

name
string

The name of the segment

Example:

"Enterprise Technology Companies"

internalName
string

The internal name of the segment

Example:

"EnterpriseTech500Plus"

description
string

A description of the segment

Example:

"Large technology companies with 500+ employees seeking digital transformation"

strategicFit
string[]

Why this segment matters to us: the fit between what we offer and what they need, and the unique attributes of this segment that align to our offering.

Example:
operatingCharacteristics
string[]

Internal, qualitative, often inferred traits that distinguish this segment: org structure, maturity, operating model, culture.

Example:
buyingDynamics
string[]

How this segment makes and acts on purchasing decisions: what drives evaluation, who's involved, how the process runs, and what signals a likely buyer.

Example:
strategicPriorities
string[]

Strategic priorities this segment is pursuing

Example:
marketPressures
string[]

Market pressures affecting this segment

Example:
firmographics
object

Structured firmographic data for the segment (industry, businessModel, geography, revenue, employees). Supports custom keys via passthrough.

customFields
object[]

Custom fields for additional segment information

additionalProperties
object

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

Example:

Response

Segment updated successfully

_metadata
object
required
data
object
required