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",
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/segment/create"
payload = {
"name": "Enterprise Technology Companies",
"description": "Companies with 500+ employees in the technology sector",
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Enterprise Technology Companies',
description: 'Companies with 500+ employees in the technology sector',
additionalProperties: {tier: 'Enterprise', region: 'APAC'},
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'}
})
};
fetch('https://app.octavehq.com/api/v2/segment/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/segment/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Enterprise Technology Companies',
'description' => 'Companies with 500+ employees in the technology sector',
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/segment/create"
payload := strings.NewReader("{\n \"name\": \"Enterprise Technology Companies\",\n \"description\": \"Companies with 500+ employees in the technology sector\",\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/segment/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Enterprise Technology Companies\",\n \"description\": \"Companies with 500+ employees in the technology sector\",\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/segment/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Enterprise Technology Companies\",\n \"description\": \"Companies with 500+ employees in the technology sector\",\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"unrecognized": true,
"rejected": true,
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"active": true,
"data": {
"strategicFit": [],
"firmographics": {
"industry": [],
"businessModel": [],
"geography": [],
"revenue": [],
"employees": []
},
"operatingCharacteristics": [],
"strategicPriorities": [],
"marketPressures": [],
"buyingDynamics": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"intelOverride": {
"enabled": true,
"guidance": "<string>"
},
"tags": [
{
"tagGroupOId": "<string>",
"tagGroupName": "<string>",
"tagOId": "<string>",
"tagName": "<string>"
}
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Segment
Create Segment
Create a new market segment
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",
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/segment/create"
payload = {
"name": "Enterprise Technology Companies",
"description": "Companies with 500+ employees in the technology sector",
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Enterprise Technology Companies',
description: 'Companies with 500+ employees in the technology sector',
additionalProperties: {tier: 'Enterprise', region: 'APAC'},
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'}
})
};
fetch('https://app.octavehq.com/api/v2/segment/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/segment/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Enterprise Technology Companies',
'description' => 'Companies with 500+ employees in the technology sector',
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/segment/create"
payload := strings.NewReader("{\n \"name\": \"Enterprise Technology Companies\",\n \"description\": \"Companies with 500+ employees in the technology sector\",\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/segment/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Enterprise Technology Companies\",\n \"description\": \"Companies with 500+ employees in the technology sector\",\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/segment/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Enterprise Technology Companies\",\n \"description\": \"Companies with 500+ employees in the technology sector\",\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"unrecognized": true,
"rejected": true,
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"active": true,
"data": {
"strategicFit": [],
"firmographics": {
"industry": [],
"businessModel": [],
"geography": [],
"revenue": [],
"employees": []
},
"operatingCharacteristics": [],
"strategicPriorities": [],
"marketPressures": [],
"buyingDynamics": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"intelOverride": {
"enabled": true,
"guidance": "<string>"
},
"tags": [
{
"tagGroupOId": "<string>",
"tagGroupName": "<string>",
"tagOId": "<string>",
"tagName": "<string>"
}
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Segment creation data
The name of the segment
Minimum string length:
1Example:
"Enterprise Technology Companies"
The description of the segment
Example:
"Companies with 500+ employees in the technology sector"
Workspace-defined additional property values for this segment, keyed by property key.
Show child attributes
Show child attributes
Example:
{ "tier": "Enterprise", "region": "APAC" }
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"
Strategy for linking this segment to offerings (products/services)
- Option 1
- Option 2
Show child attributes
Show child attributes
⌘I