Skip to main content
POST
/
api
/
v2
/
segment
/
create
Create Segment
curl --request POST \
  --url https://app.octavehq.com/api/v2/segment/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "name": "Enterprise Technology Companies",
  "description": "Companies with 500+ employees in the technology sector",
  "data": {},
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  }
}'
{
  "_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 creation data

name
string
required

The name of the segment

Minimum length: 1
Example:

"Enterprise Technology Companies"

description
string

The description of the segment

Example:

"Companies with 500+ employees in the technology sector"

data
object

Additional segment data

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 persona to products/offerings Strategy for linking this segment to products/offerings

  • Option 1
  • Option 2

Response

Segment created successfully

_metadata
object
required
data
object
required
I