Skip to main content
POST
/
api
/
v2
/
segment
/
update
Update Segment
curl --request POST \
  --url https://app.octavehq.com/api/v2/segment/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "oId": "sg_1234",
  "name": "Enterprise Technology Companies",
  "internalName": "EnterpriseTech500Plus",
  "description": "Large technology companies with 500+ employees seeking digital transformation",
  "firmographicCharacteristics": [
    "Typically mid-market to enterprise companies with 200-5000 employees.",
    "Series B through late-stage or publicly traded, with established revenue streams.",
    "Predominantly North American footprint with growing international presence.",
    "Sales-led or hybrid go-to-market motion with dedicated account management."
  ],
  "relevanceToOurBusiness": [
    "High contract values driven by complex operational requirements.",
    "Strong expansion potential as adoption spreads across departments."
  ],
  "definingAttributes": [
    "Heavy reliance on cross-functional workflows spanning engineering and operations.",
    "Decision-making distributed across technical and business stakeholders."
  ],
  "businessDrivers": [
    "Revenue growth through expansion into adjacent markets.",
    "Operational efficiency gains to protect margins at scale."
  ],
  "strategicPriorities": [
    "Investing in automation to reduce manual operational overhead.",
    "Building data infrastructure to support real-time decision making."
  ],
  "marketPressures": [
    "Increasing competition from well-funded startups offering point solutions.",
    "Regulatory complexity growing across multiple jurisdictions."
  ],
  "firmographics": {
    "industry": [],
    "businessModel": [],
    "geography": [],
    "revenue": [],
    "employees": []
  },
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "unrecognized": true,
    "rejected": true,
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "active": true,
    "data": {
      "relevanceToOurBusiness": [],
      "firmographics": {
        "industry": [],
        "businessModel": [],
        "geography": [],
        "revenue": [],
        "employees": []
      },
      "firmographicCharacteristics": [],
      "definingAttributes": [],
      "businessDrivers": [],
      "strategicPriorities": [],
      "marketPressures": [],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ],
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

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"

firmographicCharacteristics
string[]

Firmographic characteristics of the segment

Example:
[
"Typically mid-market to enterprise companies with 200-5000 employees.",
"Series B through late-stage or publicly traded, with established revenue streams.",
"Predominantly North American footprint with growing international presence.",
"Sales-led or hybrid go-to-market motion with dedicated account management."
]
relevanceToOurBusiness
string[]

Why this segment matters to our business

Example:
[
"High contract values driven by complex operational requirements.",
"Strong expansion potential as adoption spreads across departments."
]
definingAttributes
string[]

Key attributes that distinguish this segment

Example:
[
"Heavy reliance on cross-functional workflows spanning engineering and operations.",
"Decision-making distributed across technical and business stakeholders."
]
businessDrivers
string[]

Key business drivers for this segment

Example:
[
"Revenue growth through expansion into adjacent markets.",
"Operational efficiency gains to protect margins at scale."
]
strategicPriorities
string[]

Strategic priorities this segment is pursuing

Example:
[
"Investing in automation to reduce manual operational overhead.",
"Building data infrastructure to support real-time decision making."
]
marketPressures
string[]

Market pressures affecting this segment

Example:
[
"Increasing competition from well-funded startups offering point solutions.",
"Regulatory complexity growing across multiple jurisdictions."
]
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

Response

Segment updated successfully

_metadata
object
required
data
object
required