Skip to main content
DELETE
/
api
/
v2
/
segment
/
delete
Delete Segment
curl --request DELETE \
  --url https://app.octavehq.com/api/v2/segment/delete \
  --header 'api_key: <api-key>'
import requests

url = "https://app.octavehq.com/api/v2/segment/delete"

headers = {"api_key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/segment/delete', 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/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://app.octavehq.com/api/v2/segment/delete"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("api_key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://app.octavehq.com/api/v2/segment/delete")
.header("api_key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/segment/delete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "unrecognized": true,
  "rejected": true,
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "active": true,
  "data": {
    "strategicFit": [],
    "firmographics": {
      "industry": [],
      "businessModel": [],
      "geography": [],
      "revenue": [],
      "employees": []
    },
    "operatingCharacteristics": [],
    "strategicPriorities": [],
    "marketPressures": [],
    "buyingDynamics": [],
    "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>"
  }
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Segment OId

Response

Deleted segment data

_metadata
object
required
oId
string
required

Segment OId

createdAt
string | null
required

Creation date

name
string
required

Segment name

internalName
string
required

Segment internal name

description
string
required

Segment description

unrecognized
boolean
required
rejected
boolean
required
updatedAt
string | null

Updated date

deletedAt
string | null
archivedAt
string | null
active
boolean
default:true
data
object | null
qualifyingQuestions
object[] | null

Qualifying questions

user
object | null

User data

workspace
object | null

Workspace data