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",
  "fitExplanation": "These companies have the budget and technical complexity that benefits from our solution",
  "firmographics": {
    "Company Size": [
      "500-1000 employees",
      "1000+ employees"
    ],
    "Industry": [
      "Technology",
      "Software",
      "SaaS"
    ],
    "Revenue": [
      "$50M-$500M",
      "$500M+"
    ]
  },
  "keyPriorities": [
    "Digital transformation",
    "Operational efficiency",
    "Cost reduction"
  ],
  "keyConsiderations": [
    "Long sales cycles",
    "Multiple decision makers",
    "Compliance requirements"
  ],
  "uniqueApproach": [
    "Focus on ROI metrics",
    "Technical deep-dives",
    "Executive-level messaging"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "data": {
    "oId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "active": true,
    "data": {
      "fitExplanation": "<string>",
      "firmographics": {},
      "keyPriorities": [
        "<string>"
      ],
      "keyConsiderations": [
        "<string>"
      ],
      "uniqueApproach": [
        "<string>"
      ],
      "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>"
    },
    "unrecognized": true,
    "rejected": true
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Segment update input

oId
string
required

The ID of the segment to update

Minimum 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"

fitExplanation
string

Explanation of why this segment is a good fit

Example:

"These companies have the budget and technical complexity that benefits from our solution"

firmographics
object

Firmographic characteristics of the segment

Example:
{
"Company Size": ["500-1000 employees", "1000+ employees"],
"Industry": ["Technology", "Software", "SaaS"],
"Revenue": ["$50M-$500M", "$500M+"]
}
keyPriorities
string[]

Key priorities for this segment

Example:
[
"Digital transformation",
"Operational efficiency",
"Cost reduction"
]
keyConsiderations
string[]

Key considerations when selling to this segment

Example:
[
"Long sales cycles",
"Multiple decision makers",
"Compliance requirements"
]
uniqueApproach
string[]

Unique approach needed for this segment

Example:
[
"Focus on ROI metrics",
"Technical deep-dives",
"Executive-level messaging"
]
customFields
object[]

Custom fields for additional segment information

Response

Segment updated successfully

_metadata
object
required
data
object
required
I